zydronium/manage.get.gov
1
0
Fork 0
mirror of https://github.com/cisagov/manage.get.gov.git synced 2025-05-30 01:10:04 +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

13
.github/pull_request_template.md vendored
View file

@ -64,7 +64,6 @@ Resolves #001
- [ ] If any model was updated to modify/add/delete columns, verified migrations can be run with `makemigrations` - [ ] If any model was updated to modify/add/delete columns, verified migrations can be run with `makemigrations`
#### Validated user-facing changes as a developer #### Validated user-facing changes as a developer
**Note:** Multiple code reviewers can share the checklists above, a second reviewers should not make a duplicate checklist **Note:** Multiple code reviewers can share the checklists above, a second reviewers should not make a duplicate checklist
- [ ] New pages have been added to .pa11yci file so that they will be tested with our automated accessibility testing - [ ] New pages have been added to .pa11yci file so that they will be tested with our automated accessibility testing
@ -86,13 +85,11 @@ Resolves #001
- [ ] Checked different states (empty, one, some, error) - [ ] Checked different states (empty, one, some, error)
- [ ] Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI) - [ ] Tested general usability, landmarks, page header structure, and links with a screen reader (such as Voiceover or ANDI)
- [ ] Tested with multiple browsers (check off which ones were used)
#### Test support on multiple browsers. Check the browser(s) tested. - [ ] Chrome
- [ ] Chrome - [ ] Microsoft Edge
- [ ] Microsoft Edge - [ ] FireFox
- [ ] FireFox - [ ] Safari
- [ ] Safari
- [ ] (Rarely needed) Tested as both an analyst and applicant user - [ ] (Rarely needed) Tested as both an analyst and applicant user
## Screenshots ## Screenshots

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

@ -1,5 +1,8 @@
## Code Review ## 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: After creating a pull request, pull request submitters should:
- Add at least 2 developers as PR reviewers (only 1 will need to approve). - 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. - 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. - 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. 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 ## 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. 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 ## Coding standards
(The Coding standards section may be moved to a new code standards file in a future ticket. (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) For now we're simply moving PR template content into the code review document for consolidation)