diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index fb93cb530..c777e39aa 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,43 +1,10 @@ -# Pull Request +_What issues does this PR close?_ -_Briefly describe WHAT your PR changes, which features it adds/modifies._ -## How Has This Been Tested? - -Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration - -- Test A -- Test B -- ... - -**Test Configuration**: - -- Firmware version: -- Hardware: -- Toolchain: -- SDK: - -## Linked Issue(s) - -_Use keywords to automate: https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword_ - -- fixes # (issue) -- closes # (issue) -- ... - -## PR is blocked by - -- [ ] blocked by # (issue) - -# Checklist - -- [ ] I have **formatted the title** correctly and precisely -- [ ] My code follows the **style guidelines** of this project -- [ ] I have performed a **self-review** of my own code -- [ ] I have **commented** my code, particularly in hard-to-understand areas and public classes/methods -- [ ] I have made corresponding changes to the **documentation** -- [ ] My changes generate **no new warnings** (performed checkstyle check locally) -- [ ] I have added **tests that prove my fix** is effective or that my feature works -- [ ] New and existing unit **tests pass locally** with my changes -- [ ] Any dependent **changes have been merged** and published in downstream modules -- [ ] I have added/updated **copyright headers** +```[tasklist] +### Checklist +- [ ] The PR title is short and expressive. +- [ ] I have updated the CHANGELOG.md. See [changelog_update.md](https://github.com/sovity/authority-portal/tree/main/docs/dev/changelog_updates.md) for more information. +- [ ] I have updated the Deployment Migration Notes Section in the CHANGELOG.md for any configuration / external API changes. +- [ ] I have performed a **self-review** +```