-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated the PR template to latest agreed format (#2122)
* Updated the PR template to latest agreed format. * Reworked format and removed question marks in reviewer's checklist. * Added French translation for the related issues section. * Reworded the reviewer's checklist. * Removed superfluous description * Added further instructions on reviewer's checklist.
- Loading branch information
1 parent
807f790
commit bfadea3
Showing
1 changed file
with
11 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,65 +1,26 @@ | ||
| # 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._ | ||
|
|
||
| --- | ||
| ## Related Issues | Cartes liées | ||
|
|
||
| > 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. | ||
| * 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 : | ||
|
|
||
| - [ ] 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). | ||
|
|
||
| - [ ] 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.)? | ||
| > ⚠ 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. |