zydronium/manage.get.gov
1
0
Fork 0
mirror of https://github.com/cisagov/manage.get.gov.git synced 2025-05-28 16:29:54 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add PR naming conventions

Browse source
This commit is contained in:
Erin Song 2024-10-04 10:29:10 -07:00
parent 0283902615
commit 980f997dbc
No known key found for this signature in database
2 changed files with 11 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/dev-practices/code_review.md
View file

@ -1,5 +1,8 @@
## Code Review
Pull requests should be titled in the format of `#issue_number: Descriptive name ideally matching ticket name - [sandbox]`
Any pull requests including a migration should be suffixed with ` - MIGRATION`
After creating a pull request, pull request submitters should:
- Add at least 2 developers as PR reviewers (only 1 will need to approve).
- Message on Slack or in standup to notify the team that a PR is ready for review.
@ -7,11 +10,13 @@ After creating a pull request, pull request submitters should:
- If any updated dependencies on Pipfile, also update dependencies in requirements.txt.
Code changes on user-facing features (excluding content updates) require approval from at least one developer and one designer.
All other changes require just a single approving review.
All other changes require a single approving review.
## Pull Requests for User-facing changes
When making user-facing changes, test that your changes work on multiple browsers including Chrome, Microsoft Edge, Firefox, and Safari.
Add new pages to the .pa11yci file so they are included in our automated accessibility testing.
## Coding standards
(The Coding standards section may be moved to a new code standards file in a future ticket.
For now we're simply moving PR template content into the code review document for consolidation)