From 91d04ec675eb9fbde3d8f6b33a19affacf650678 Mon Sep 17 00:00:00 2001
From: Daniel Metcalfe <mrdanielmetcalfe@gmail.com>
Date: Tue, 5 Mar 2024 12:46:30 +0000
Subject: [PATCH] General updates to PR template

Some suggestions based on using it for a while.
---
 .github/pull_request_template.md | 41 ++++++++++++--------------------
 1 file changed, 15 insertions(+), 26 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 9426b7d..0f0c552 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,51 +1,40 @@
-## What does this change?
-
 <!--
-**NOTE**: This is meant as a guide and memory jog, not a prescriptive list of tasks you must do!
+This is meant as a guide and memory jog, not a prescriptive list of tasks you must do!
 Feel free to modify as suits, just please do read over and make sure you've at least thought about the points and if there's any impact.
 -->
 
 <!--
-Add details of the change here. A PR should have enough detail to be understandable far in the future. e.g what is the problem/why is the change needed, how does it solve it and any questions or points of discussion.
+Append the ticket *task ID* to the PR description like so: Awesome update [GEN-123]
 
-Add any relevant tickets or links, eg: Resolves [ticket](http://link-to-ticket)
+Notion will detect this and add a link to the original ticket as a comment.
 -->
 
 ## Testing
 
-- [ ] I wrote new unit tests for this change
-- [ ] I wrote new integration/e2e tests for this change
-- [ ] I updated existing tests for this change
-- [ ] I ran test commands to test this change (list below)
-
-```
-npm run test
-```
+- [ ] I have tested this change against all known scenarios and considered new ones.
+  - E.g. net negative import scenario for solution summary graph.
+- [ ] I have tested this change against real data
 
 ## Monitoring
 
 - [ ] This change can be deployed to prod without triggering any alarms
 - [ ] This change will be covered by our existing monitoring
-      (no new /metrics/dashboards/alarms are required)
+  - No new CloudWatch alarm or Sentry logging is required
 - [ ] This change will have no (or positive) effect on resources and/or limits
-      (including CPU, memory, AWS resources, calls to other services)
-- [ ] This change requires the cache to be flushed after deployment
-  - Usually applicable for APIs when a DTO has been updated
+  - Including CPU, memory, AWS resources, calls to other services
 
 ## Rollout
 
-- [ ] This change can be merged immediately into the pipeline upon approval (no upstream/downstream/config updates required first)
+- [ ] This change can be merged immediately into the pipeline upon approval
+  - No upstream/downstream/config updates required first
 - [ ] All dependent changes are already deployed to prod
-- [ ] This change can be rolled back without any issues after deployment to prod
-
-## UI
-
-<!-- Usually only applicable to UI changes: what did it look like before and what will it look like after? -->
 
-### Design review
+## Rollback
 
-- [ ] I requested review from jacklsmith
+- [ ] This change can be rolled back without any issues after deployment to prod.
+  - Write out the steps to rollback the change below if helpful.
 
-### Images
+## UI
 
 - [ ] I added images demonstrating the changes in desktop and mobile views
+- [ ] I've checked the changes in Firefox and Safari