From a33cde779c06eccf1006a2c63a9c3a0b3f44436a Mon Sep 17 00:00:00 2001 From: Spencer Alan Date: Tue, 11 Dec 2018 14:34:56 -0500 Subject: [PATCH] add pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+), 0 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..96b13fc --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,41 @@ +## Why? + +What is the problem this PR attempts to solve, and why is it important? Fixing a bug? Explain the problem you're solving. Laying a foundation for future work? Explain how this fits into the bigger picture. Don't forget to link to the Clubhouse issue above. + +## What? + +What does this PR change, and how does that solve the problem noted above? Call out any related changes, and add before-and-after screenshots for UI updates. + +## Caveats + +Are there downsides or side-effects that should be weighed against this update? Any lingering unknowns or things you can’t test without production data or traffic? + +## Testing Notes + +Is any special setup required to test this change? Non-obvious things that should be checked? + +A list of things to test: + +- [ ] Test item 1 +- [ ] Test item 2 +- [ ] Test item 3 + +## Deploy Tasks + +Note anything that needs to be done before, during, or after this change is deployed. Also add the “deploy task” label to this PR and the Clubhouse issue so it's obvious the next time we make a deployment. + +- [ ] Update the database things +- [ ] Tell Client Experience this issue is now resolved +- [ ] Confirm that emails are still being sent + +## Alternatives Considered + +Were there other approaches or solutions to this problem which you considered? Why were they not chosen? + +## Further Reading + +Were there articles or StackOverflow answers you found especially eye-opening when working on this? Slack conversation around this? Provide a link to the thread. + +## Merge Instructions + +Please **DO NOT** squash my commits when merging -- libgit2 0.21.0