add pull request template

Spencer Alan
1 parent 2ff3774f
Showing 1 changed file with 41 additions and 0 deletions Show diff stats
.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
...	...	@@ -0,0 +1,41 @@
	1	+## Why?
	2	+
	3	+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.
	4	+
	5	+## What?
	6	+
	7	+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.
	8	+
	9	+## Caveats
	10	+
	11	+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?
	12	+
	13	+## Testing Notes
	14	+
	15	+Is any special setup required to test this change? Non-obvious things that should be checked?
	16	+
	17	+A list of things to test:
	18	+
	19	+- [ ] Test item 1
	20	+- [ ] Test item 2
	21	+- [ ] Test item 3
	22	+
	23	+## Deploy Tasks
	24	+
	25	+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.
	26	+
	27	+- [ ] Update the database things
	28	+- [ ] Tell Client Experience this issue is now resolved
	29	+- [ ] Confirm that emails are still being sent
	30	+
	31	+## Alternatives Considered
	32	+
	33	+Were there other approaches or solutions to this problem which you considered? Why were they not chosen?
	34	+
	35	+## Further Reading
	36	+
	37	+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.
	38	+
	39	+## Merge Instructions
	40	+
	41	+Please DO NOT squash my commits when merging
...	...