Skip to content

Commit

Permalink
Added PR instructions on ai code review + md linter fixes (#1532)
Browse files Browse the repository at this point in the history
Co-authored-by: Jumana B <[email protected]>
  • Loading branch information
jimleroyer and jzbahrai authored Sep 12, 2024
1 parent ea1e628 commit 46cb997
Showing 1 changed file with 28 additions and 9 deletions.
37 changes: 28 additions & 9 deletions pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,39 @@ _TODO: 1-3 sentence description of the changed you're proposing._
* 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
## Before merging this PR

Read code suggestions left by the
[cds-ai-codereviewer](https://github.com/cds-snc/cds-ai-codereviewer/) bot. Address
valid suggestions and shortly write down reasons to not address others. To help
with the classification of the comments, please use these reactions on each of the
comments made by the AI review:

| Classification | Reaction | Emoticon |
|---------------------|----------|----------|
| Useful | +1 | 👍 |
| Noisy | eyes | 👀 |
| Hallucination | confused | 😕 |
| Wrong but teachable | rocket | 🚀 |
| Wrong and incorrect | -1 | 👎 |

The classifications will be extracted and summarized into an analysis of how helpful
or not the AI code review really is.

## Test instructions | Instructions pour tester la modification

_TODO: Fill in test instructions for the reviewer._

# Release Instructions | Instructions pour le déploiement
## Release Instructions | Instructions pour le déploiement

None.

# Reviewer checklist | Liste de vérification du réviseur
## Reviewer checklist | Liste de vérification du réviseur

- [ ] 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).
* [ ] 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).

> ⚠ 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.
> ⚠ 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.

0 comments on commit 46cb997

Please sign in to comment.