diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3b1abbdc5..5420f8f77 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1,49 @@ ---- + - +Fixes: -**What's this PR do?** + -**Screenshots?** +**Screenshots and screen captures:** -**You have tested this PR on:** +**Platforms this PR was tested on:** - [ ] Windows -- [ ] Linux/Ubuntu - [ ] macOS +- [ ] Linux (specify distro) + +
+Self-review checklist + + + + + +- [ ] [Self-reviewed](https://zulip.readthedocs.io/en/latest/contributing/code-reviewing.html#how-to-review-code) the changes for clarity and maintainability + (variable names, code reuse, readability, etc.). + +Communicate decisions, questions, and potential concerns. + +- [ ] Explains differences from previous plans (e.g., issue description). +- [ ] Highlights technical choices and bugs encountered. +- [ ] Calls out remaining decisions and concerns. +- [ ] Automated tests verify logic where appropriate. + +Individual commits are ready for review (see [commit discipline](https://zulip.readthedocs.io/en/latest/contributing/commit-discipline.html)). + +- [ ] Each commit is a coherent idea. +- [ ] Commit message(s) explain reasoning and motivation for changes. + +Completed manual review and testing of the following: + +- [ ] Visual appearance of the changes. +- [ ] Responsiveness and internationalization. +- [ ] Strings and tooltips. +- [ ] End-to-end functionality of buttons, interactions and flows. +- [ ] Corner cases, error conditions, and easily imagined bugs. +