diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c210fb441e..941cb5a6c5 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,36 +1,41 @@ - - -**What does this PR do?** - - - - - -**Tested?** -- [ ] Manually -- [ ] Existing tests (adapted, if necessary) -- [ ] New tests added (for any new behavior) -- [ ] Passed linting & tests (each commit) - - - -**Commit flow** - +### What does this PR do, and why? + + + +### Outstanding aspect(s) + + +- [ ] + +### External discussion & connections + +- [ ] Discussed in **#zulip-terminal** in `topic` +- [ ] Fully fixes # +- [ ] Partially fixes issue # +- [ ] Builds upon previous unmerged work in PR # +- [ ] Is a follow-up to work in PR # +- [ ] Requires merge of PR # +- [ ] Merge will enable work on # + +### How did you test this? + +- [ ] Manually - Behavioral changes +- [ ] Manually - Visual changes +- [ ] Adapting existing automated tests +- [ ] Adding automated tests for new behavior (or missing tests) +- [ ] Existing automated tests should already cover this (*only a refactor of tested code*) + +### Self-review checklist for each commit +- [ ] It is a [minimal coherent idea](https://github.com/zulip/zulip-terminal#structuring-commits---speeding-up-reviews-merging--development) +- [ ] It has a commit summary following the [documented style](https://github.com/zulip/zulip-terminal#structuring-commits---speeding-up-reviews-merging--development) (title & body) +- [ ] It has a commit summary describing the motivation and reasoning for the change +- [ ] It individually passes linting and tests +- [ ] It contains test additions for any new behavior +- [ ] It flows clearly from a previous branch commit, and/or prepares for the next commit + +### Visual changes + + - -**Notes & Questions** - - -**Interactions** - - -**Visual changes**