From 63dcf2c9d105b5d3f35747572c91dfd08c5f822b Mon Sep 17 00:00:00 2001 From: Jimmy Royer Date: Tue, 27 Feb 2024 21:50:48 -0500 Subject: [PATCH 1/6] Updated the PR template to latest agreed format. --- pull_request_template.md | 59 ++++++++-------------------------------- 1 file changed, 11 insertions(+), 48 deletions(-) diff --git a/pull_request_template.md b/pull_request_template.md index f1ffb136c6..b5825f03f1 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -1,65 +1,28 @@ # Summary | Résumé -> 1-3 sentence description of the changed you're proposing, including a link to -> a GitHub Issue # or Trello card if applicable. +_TODO: 1-3 sentence description of the changed you're proposing._ ---- - -> Description en 1 à 3 phrases de la modification proposée, avec un lien vers le -> problème (« issue ») GitHub ou la fiche Trello, le cas échéant. +Issue: + https://app.zenhub.com/workspaces/notify-planning-614b3ad91bc2030015ed22f5/issues/gh/cds-snc/notification-planning/1 + https://app.zenhub.com/workspaces/notify-planning-core-6411dfb7c95fb80014e0cab0/issues/gh/cds-snc/notification-planning-core/1 # Test instructions | Instructions pour tester la modification -> Sequential steps (1., 2., 3., ...) that describe how to test this change. This -> will help a developer test things out without too much detective work. Also, -> include any environmental setup steps that aren't in the normal README steps -> and/or any time-based elements that this requires. - ---- - -> Étapes consécutives (1., 2., 3., …) qui décrivent la façon de tester la -> modification. Elles aideront les développeurs à faire des tests sans avoir à -> jouer au détective. Veuillez aussi inclure toutes les étapes de configuration -> de l’environnement qui ne font pas partie des étapes normales dans le fichier -> README et tout élément temporel requis. +_TODO: Fill in test instructions for the reviewer._ # Release Instructions | Instructions pour le déploiement None. -> Necessary steps to perform before and after the deployment of these changes. -> For example, emptying the cache on a feature that changes the cache data -> structure in Redis could be mentioned. - ---- - -> Étapes nécessaires à exécuter avant et après le déploiement des changements -> introduits par cette proposition. Par exemple, vider la cache suite à des -> changements modifiant une structure de données de la cache pourrait être -> mentionné. - # Reviewer checklist | Liste de vérification du réviseur This is a suggested checklist of questions reviewers might ask during their review | Voici une suggestion de liste de vérification comprenant des questions que les réviseurs pourraient poser pendant leur examen : - -- [ ] Is the code maintainable? | Est-ce que le code peut être maintenu? -- [ ] Have you tested it? | L’avez-vous testé? -- [ ] Are there automated tests? | Y a-t-il des tests automatisés? -- [ ] Does this cause automated test coverage to drop? | Est-ce que ça entraîne - une baisse de la quantité de code couvert par les tests automatisés? -- [ ] Does this break existing functionality? | Est-ce que ça brise une - fonctionnalité existante? -- [ ] Does this change the privacy policy? | Est-ce que ça entraîne une - modification de la politique de confidentialité? -- [ ] Does this introduce any security concerns? | Est-ce que ça introduit des - préoccupations liées à la sécurité? -- [ ] Does this significantly alter performance? | Est-ce que ça modifie de - façon importante la performance? -- [ ] What is the risk level of using added dependencies? | Quel est le degré de - risque d’utiliser des dépendances ajoutées? -- [ ] Should any documentation be updated as a result of this? (i.e. README - setup, etc.) | Faudra-t-il mettre à jour la documentation à la suite de ce - changement (fichier README, etc.)? +- [ ] Check that the current PR does not break existing functionality. +- [ ] Check that this does not violate GCNotify's privacy policies? +- [ ] Check that this does not raise any security concern? +- [ ] Check that this does not significantly alter performance? +- [ ] Check if additional documentation needs to be updated as a result of these changes such + as the README, setup instructions, a related ADR or the technical documentation. From 1d483dc4f4600f3186294ad16cb0e23d950e598e Mon Sep 17 00:00:00 2001 From: Jimmy Royer Date: Tue, 27 Feb 2024 22:17:21 -0500 Subject: [PATCH 2/6] Reworked format and removed question marks in reviewer's checklist. --- pull_request_template.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/pull_request_template.md b/pull_request_template.md index b5825f03f1..34f92c6bb3 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -2,9 +2,10 @@ _TODO: 1-3 sentence description of the changed you're proposing._ -Issue: - https://app.zenhub.com/workspaces/notify-planning-614b3ad91bc2030015ed22f5/issues/gh/cds-snc/notification-planning/1 - https://app.zenhub.com/workspaces/notify-planning-core-6411dfb7c95fb80014e0cab0/issues/gh/cds-snc/notification-planning-core/1 +## Related Issues + +* https://app.zenhub.com/workspaces/notify-planning-614b3ad91bc2030015ed22f5/issues/gh/cds-snc/notification-planning/1 +* https://app.zenhub.com/workspaces/notify-planning-core-6411dfb7c95fb80014e0cab0/issues/gh/cds-snc/notification-planning-core/1 # Test instructions | Instructions pour tester la modification @@ -21,8 +22,8 @@ review | Voici une suggestion de liste de vérification comprenant des questions que les réviseurs pourraient poser pendant leur examen : - [ ] Check that the current PR does not break existing functionality. -- [ ] Check that this does not violate GCNotify's privacy policies? -- [ ] Check that this does not raise any security concern? -- [ ] Check that this does not significantly alter performance? +- [ ] Check that this does not violate GCNotify's privacy policies. +- [ ] Check that this does not raise any security concern. +- [ ] Check that this does not significantly alter performance. - [ ] Check if additional documentation needs to be updated as a result of these changes such as the README, setup instructions, a related ADR or the technical documentation. From f9255d2219fbd2ab1315b18b1fd8c5c67e372147 Mon Sep 17 00:00:00 2001 From: Jimmy Royer Date: Wed, 28 Feb 2024 13:58:42 -0500 Subject: [PATCH 3/6] Added French translation for the related issues section. --- pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pull_request_template.md b/pull_request_template.md index 34f92c6bb3..7f22194fc7 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -2,7 +2,7 @@ _TODO: 1-3 sentence description of the changed you're proposing._ -## Related Issues +## Related Issues | Cartes liées * https://app.zenhub.com/workspaces/notify-planning-614b3ad91bc2030015ed22f5/issues/gh/cds-snc/notification-planning/1 * https://app.zenhub.com/workspaces/notify-planning-core-6411dfb7c95fb80014e0cab0/issues/gh/cds-snc/notification-planning-core/1 From 18916c4ef292dca2675e338857dcde752230a998 Mon Sep 17 00:00:00 2001 From: Jimmy Royer Date: Wed, 28 Feb 2024 14:07:42 -0500 Subject: [PATCH 4/6] Reworded the reviewer's checklist. --- pull_request_template.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/pull_request_template.md b/pull_request_template.md index 7f22194fc7..0d43a5d4df 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -21,9 +21,8 @@ This is a suggested checklist of questions reviewers might ask during their review | Voici une suggestion de liste de vérification comprenant des questions que les réviseurs pourraient poser pendant leur examen : -- [ ] Check that the current PR does not break existing functionality. -- [ ] Check that this does not violate GCNotify's privacy policies. -- [ ] Check that this does not raise any security concern. -- [ ] Check that this does not significantly alter performance. -- [ ] Check if additional documentation needs to be updated as a result of these changes such - as the README, setup instructions, a related ADR or the technical documentation. +- [ ] This PR does not break existing functionality. +- [ ] This PR does not violate GCNotify's privacy policies. +- [ ] This PR does not raise new security concerns. Refer to our GC Notify Risk Register document on our Google drive. +- [ ] This PR does not significantly alter performance. +- [ ] Additional required documentation resulting of these changes is covered (such as the README, setup instructions, a related ADR or the technical documentation). From 2af15a5fce025d8c6edeedc4996a953c5eba896a Mon Sep 17 00:00:00 2001 From: Jimmy Royer Date: Wed, 28 Feb 2024 14:30:31 -0500 Subject: [PATCH 5/6] Removed superfluous description --- pull_request_template.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/pull_request_template.md b/pull_request_template.md index 0d43a5d4df..4aad976600 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -17,10 +17,6 @@ None. # Reviewer checklist | Liste de vérification du réviseur -This is a suggested checklist of questions reviewers might ask during their -review | Voici une suggestion de liste de vérification comprenant des questions -que les réviseurs pourraient poser pendant leur examen : - - [ ] This PR does not break existing functionality. - [ ] This PR does not violate GCNotify's privacy policies. - [ ] This PR does not raise new security concerns. Refer to our GC Notify Risk Register document on our Google drive. From 7e2c2044ae78e0baa905cc8dd63b80d6308c2eb8 Mon Sep 17 00:00:00 2001 From: Jimmy Royer Date: Wed, 28 Feb 2024 17:00:18 -0500 Subject: [PATCH 6/6] Added further instructions on reviewer's checklist. --- pull_request_template.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pull_request_template.md b/pull_request_template.md index 4aad976600..483d2b2639 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -22,3 +22,5 @@ None. - [ ] This PR does not raise new security concerns. Refer to our GC Notify Risk Register document on our Google drive. - [ ] This PR does not significantly alter performance. - [ ] Additional required documentation resulting of these changes is covered (such as the README, setup instructions, a related ADR or the technical documentation). + +> ⚠ If boxes cannot be checked off before merging the PR, they should be moved to the "Release Instructions" section with appropriate steps required to verify before release. For example, changes to celery code may require tests on staging to verify that performance has not been affected. \ No newline at end of file