Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the PR template to latest agreed format #2122

Merged
merged 7 commits into from
Feb 29, 2024
Merged

Conversation

jimleroyer
Copy link
Member

@jimleroyer jimleroyer commented Feb 28, 2024

Summary | Résumé

Updated the PR template to latest agreed format!

And this very PR uses the latest format itself, this is meta. 🤖

Related Issues

Test instructions | Instructions pour tester la modification

Please proceed below 👇 to check the new boxes in the reviewer's checklist please. 🙏

Release Instructions | Instructions pour le déploiement

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 :

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

pull_request_template.md Show resolved Hide resolved
pull_request_template.md Outdated Show resolved Hide resolved
pull_request_template.md Outdated Show resolved Hide resolved
@jimleroyer jimleroyer self-assigned this Feb 28, 2024
pull_request_template.md Outdated Show resolved Hide resolved
@sastels
Copy link
Collaborator

sastels commented Feb 28, 2024

I ask out of ignorance since I missed the meeting yesterday: are there thoughts around what is sufficient around testing? in particular it may be hard to decide the affect on performance of, for example, celery changes, without doing some testing on staging after a PR is merged in. I would suggest in cases like this the reviewer shouldn't check the box but rather comment that we should do some staging tests before release. thoughts?

@jimleroyer jimleroyer requested a review from sastels February 28, 2024 20:17
Copy link
Member Author

@jimleroyer jimleroyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I ask out of ignorance since I missed the meeting yesterday: are there thoughts around what is sufficient around testing? in particular it may be hard to decide the affect on performance of, for example, celery changes, without doing some testing on staging after a PR is merged in. I would suggest in cases like this the reviewer shouldn't check the box but rather comment that we should do some staging tests before release. thoughts?

Yes, there might be additional required tests that changes do not cover and need to be performed after the PR is merged. There might be a negotiation with the reviewer(s) and author(s). Do you see an additional requirement check or modifying an existing one to fit this use case in? Or we want to keep it this way, with an implicit understanding that this should happen? (and keep it short)

changement (fichier README, etc.)?
- [ ] 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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we link to the Risk Register doc here 🙏

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmmm... what is the likelihood that a reviewer is going to click and scroll through that document each time? I'd err on not having it in the PR review

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought of linking it but I am paranoid. I checked access to the document and this is protected, but I fell for security through obscurity on this one as this is a sensitive document. I can put it there if you pay me cider later on.

@jzbahrai
Copy link
Collaborator

in response to your other comment jimmy and steve, I would like to keep it this way, with an implicit understanding that this should happen

@sastels
Copy link
Collaborator

sastels commented Feb 28, 2024

I ask out of ignorance since I missed the meeting yesterday: are there thoughts around what is sufficient around testing? in particular it may be hard to decide the affect on performance of, for example, celery changes, without doing some testing on staging after a PR is merged in. I would suggest in cases like this the reviewer shouldn't check the box but rather comment that we should do some staging tests before release. thoughts?

Yes, there might be additional required tests that changes do not cover and need to be performed after the PR is merged. There might be a negotiation with the reviewer(s) and author(s). Do you see an additional requirement check or modifying an existing one to fit this use case in? Or we want to keep it this way, with an implicit understanding that this should happen? (and keep it short)

Maybe just a bit after the checkboxes, something like
"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."

Copy link
Collaborator

@sastels sastels left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is such an improvement! 🎉

Let's followup in a month to see if it needs refinement.

Copy link
Member

@andrewleith andrewleith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@jimleroyer jimleroyer merged commit bfadea3 into main Feb 29, 2024
4 checks passed
@jimleroyer jimleroyer deleted the doc/pr-desc branch February 29, 2024 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants