zydronium/manage.get.gov
1
0
Fork 0
mirror of https://github.com/cisagov/manage.get.gov.git synced 2025-05-13 08:07:03 +02:00
Code Issues Projects Releases Packages Wiki Activity

Updated with review comments

Browse source
This commit is contained in:
Erin Song 2024-10-15 16:50:43 -07:00
parent b6e3405966
commit 2dd8d53ec9
No known key found for this signature in database
2 changed files with 8 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

9
.github/pull_request_template.md vendored
View file

@ -44,14 +44,14 @@ Resolves #00
- [ ] Update documentation in READMEs and/or onboarding guide - [ ] Update documentation in READMEs and/or onboarding guide
#### Ensured code standards are met (Original Developer) #### Ensured code standards are met (Original Developer)
<!-- Write N/A if the below code standards are not applicable to your PR --> <!-- Mark "- N/A" and check at the end of each check that is not applicable to your PR -->
- [ ] If any updated dependencies on Pipfile, also update dependencies in requirements.txt. - [ ] If any updated dependencies on Pipfile, also update dependencies in requirements.txt.
- [ ] Interactions with external systems are wrapped in try/except - [ ] Interactions with external systems are wrapped in try/except
- [ ] Error handling exists for unusual or missing values - [ ] Error handling exists for unusual or missing values
#### Validated user-facing changes (if applicable) #### Validated user-facing changes (if applicable)
- [ ] Tag @dotgov-designers for design review. If code is not user-facing, delete design reviewer checklist - [ ] Tag @dotgov-designers in this PR's Reviewers for design review. If code is not user-facing, delete design reviewer checklist
- [ ] Verify new pages have been added to .pa11yci file so that they will be tested with our automated accessibility testing - [ ] Verify new pages have been added to .pa11yci file so that they will be tested with our automated accessibility testing
- [ ] Checked keyboard navigability - [ ] Checked keyboard navigability
- [ ] 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)
@ -61,13 +61,13 @@ Resolves #00
#### Reviewed, tested, and left feedback about the changes #### Reviewed, tested, and left feedback about the changes
- [ ] Pulled this branch locally and tested it - [ ] Pulled this branch locally and tested it
- [ ] Verified code meets above code standards and user-facing checklist. Address any checks that are not satisfied - [ ] Verified code meets all checks above. Address any checks that are not satisfied
- [ ] Reviewed this code and left comments. Indicate if comments must be addressed before code is merged - [ ] Reviewed this code and left comments. Indicate if comments must be addressed before code is merged
- [ ] Checked that all code is adequately covered by tests - [ ] Checked that all code is adequately covered by tests
- [ ] Verify migrations are valid and do not conflict with existing migrations - [ ] Verify migrations are valid and do not conflict with existing migrations
#### 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. All checks should be checked before approving, even those labeled N/A.
- [ ] 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
- [ ] Checked keyboard navigability - [ ] Checked keyboard navigability
@ -81,6 +81,7 @@ Resolves #00
- [ ] Checked that the design translated visually - [ ] Checked that the design translated visually
- [ ] Checked behavior. Comment any found issues or broken flows. - [ ] Checked behavior. Comment any found issues or broken flows.
- [ ] Checked keyboard navigability
- [ ] Checked different states (empty, one, some, error) - [ ] Checked different states (empty, one, some, error)
- [ ] Checked for landmarks, page heading structure, and links - [ ] Checked for landmarks, page heading structure, and links

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

@ -12,12 +12,12 @@ After creating a pull request, pull request submitters should:
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 a single approving review. All other changes require a single approving review.
The submitter is responsible for merging their PR unless the approver is given explcit permission. Similarly, do not commit to another person's branch unless given explicit permission. The submitter is responsible for merging their PR unless the approver is given explicit permission. Similarly, do not commit to another person's branch unless given explicit permission.
Bias towards approving i.e. "good to merge once X is fixed" rather than blocking until X is fixed, requiring an additional review. Bias towards approving i.e. "good to merge once X is fixed" rather than blocking until X is fixed, requiring an additional 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 or reviewing 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. Add new pages to the .pa11yci file so they are included in our automated accessibility testing.
@ -30,5 +30,3 @@ Add new pages to the .pa11yci file so they are included in our automated accessi
### Plain language ### Plain language
All functions and methods should use plain language. All functions and methods should use plain language.
TODO: Plain language description and examples in code standards ticket.