diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 18dc42116..0b00a875b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,44 +1,40 @@ -### Changes proposed in this Pull Request: +## Description - +Please include a summary of the changes and the related issue. +Please also include relevant motivation and context. +List any dependencies that are required for this change. -Closes # . +### Type of change -_Replace this with a good description of your changes & reasoning._ +Please delete options that are not relevant. -- [ ] Do the changed files pass `phpcs` checks? Please remove `phpcs:ignore` comments in changed files and fix any issues, or delete if not practical. +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -### Screenshots: - +## Screenshots +Please provide screenshots or snapshots of the system/state both before and after implementing the changes, if appropriate +### Before +### After -### Detailed test instructions: - -1. -2. -3. +## Test instructions +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. -### Additional details: - -### Changelog entry -> +## Changelog entry + +One liner entry to be surfaced in changelog.txt