From eacf62768c29839ad127e096ab3f78f775b51bb3 Mon Sep 17 00:00:00 2001
From: "neiljp (Neil Pilgrim)" <github@kepier.clara.net>
Date: Sat, 25 Mar 2023 13:56:18 -0700
Subject: [PATCH] pull_request_template: Update and improve PR template.

The main changes are:
- Simplifying titles contributors see while editing via ### instead of bold
- Adding 'and why' to the 'What does this PR do?' top title
- Updating the 'Tested?' section to be 'How did you test this?'
  - Generally clarifying each entry
  - Manual checks split into behavioral and visual entries
  - 'Linting and tests per commit' removed in favor of a refactor-only entry
- Adding a self-review checklist (for each commit) to emphasize expectations
- Adding an 'External discussion & connections' section with checkboxes
  - The comments re including Fixes and chat link requests are here
  - The 'Interactions' section examples are also moved here
  - Other entries are added to prompt contributors (unmerged/followup PRs)
- Adds tips to the Visual changes section
  - Zulip general tools
  - using asciinema for 'videos'
---
 .github/pull_request_template.md | 75 +++++++++++++++++---------------
 1 file changed, 40 insertions(+), 35 deletions(-)

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 @@
-<!-- Please see https://github.com/zulip/zulip-terminal#contributor-guidelines ! -->
-
-**What does this PR do?**  <!-- Overall description goes here -->
-
-<!-- If fixing a filed bug or new feature, add 'Fixes #<issue>' or 'Partial fix for #<issue>' -->
-
-<!-- Add a link to a discussion on chat.zulip.org, if relevant -->
-
-**Tested?** <!-- Fine to leave some of these unchecked if this is a draft/work-in-progress -->
-- [ ] Manually
-- [ ] Existing tests (adapted, if necessary)
-- [ ] New tests added (for any new behavior)
-- [ ] Passed linting & tests (each commit)
-<!-- Code must pass CI (GitHub Actions) before merging - look for the green tick! -->
-
-<!-- See https://github.com/zulip/zulip-terminal#commit-style -->
-**Commit flow** <!-- if more than one commit; add/delete/fill-in as appropriate -->
-<!-- For example:
-- first commit doing some thing
-- maybe multiple commits doing similar things
+<!-- See README for documentation, or ask in #zulip-terminal if unclear -->
+### What does this PR do, and why?
+
+
+
+### Outstanding aspect(s)    <!-- DELETE SECTION IF EMPTY -->
+<!-- In what ways is this not fully implemented/functioning? Compared to a discussion/issue? -->
+<!-- Do you not understand something? Are you unsure about a certain approach? Want feedback? -->
+- [ ] 
+
+### External discussion & connections
+<!-- [x] all that apply, specifying topic and adding numbers after # for issues/PRs -->
+- [ ] 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?
+<!-- [x] all that apply -->
+- [ ] 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    <!-- DELETE SECTION IF NO VISUAL CHANGE -->
+<!-- Zulip tips at https://zulip.readthedocs.io/en/latest/tutorials/screenshot-and-gif-software.html -->
+<!-- For video, try asciinema; after uploading, embed using
+[![yourtitle](https://asciinema.org/a/<id>.png)](https://asciinema.org/a/<id>)
 -->
-
-**Notes & Questions** <!-- if any; add/delete/fill-in as appropriate -->
-<!-- For example:
-- this doesn't include feature X (yet?)
-- unsure about Y
-- should this do Z?
--->
-
-**Interactions** <!-- if any; add/delete/fill-in as appropriate -->
-<!-- eg.
-- Waiting on #<PR>
-- Blocks #<PR>
--->
-
-**Visual changes** <!-- if any; add/delete/fill-in with screenshot/diagram as appropriate -->