Skip to content

Commit

Permalink
docs: update pr templates (#999)
Browse files Browse the repository at this point in the history
* dev: update pull request template

* dev: add ally checklist to release PR template

* docs: add link to release testing document
  • Loading branch information
gidjin authored Apr 19, 2023
1 parent 6f42536 commit 365fab8
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 61 deletions.
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,16 @@
chore(release): <version number>
--->

---

Ally testing should be performed during the release approval process

- Performed [a11y testing](https://github.com/trussworks/accessibility/blob/master/sample_a11y_testing_process.md):
- [ ] Checked responsiveness in mobile, tablet, and desktop
- [ ] Checked keyboard navigability
- [ ] Tested with [VoiceOver](https://dequeuniversity.com/screenreaders/voiceover-keyboard-shortcuts) in Safari
- [ ] Checked VO's [rotor menu](https://github.com/trussworks/accessibility/blob/master/README.md#how-to-use-the-rotor-menu) for landmarks, page heading structure and links
- [ ] Used a browser a11y tool to check for issues (WAVE, axe, [ANDI](https://www.ssa.gov/accessibility/andi/help/install.html) or Accessibility addon tab for Storybook, see [published Storybook site](https://storybook.ussforbit.us/))

Reference: [How to review a release](https://github.com/USSF-ORBIT/ussf-portal/blob/main/docs/how-to/release-testing.md)
87 changes: 26 additions & 61 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,75 +32,40 @@
```
--->

### Start the system
```sh
yarn services:up
yarn dev
cd ../ussf-portal-cms
yarn dev
```

Login to the portal http://localhost:3000

### Start storybook

```sh
yarn storybook
```

Login to storybook http://localhost:6006, though the command above should open it for you

---

## Code review steps

### As the original developer, I have

- [ ] Met the acceptance criteria, or will meet them in subsequent PRs or stories
- ... <!-- link follow-up PRs/stories here -->
- [ ] Met the acceptance criteria
- [ ] Created new stories in Storybook if applicable
- [ ] Checked that all Storybook accessibility checks are passing
- [ ] Created/modified automated unit tests in Jest
- [ ] Including jest-axe checks when UI changes
- [ ] Created/modified automated E2E tests in Cypress
- [ ] Including cypress-axe checks when UI changes
- [ ] Checked that the E2E test build is not failing
- Performed [a11y testing](https://github.com/trussworks/accessibility/blob/master/sample_a11y_testing_process.md):
- [ ] Checked responsiveness in mobile, tablet, and desktop
- [ ] Checked keyboard navigability
- [ ] Tested with [VoiceOver](https://dequeuniversity.com/screenreaders/voiceover-keyboard-shortcuts) in Safari
- [ ] Checked VO's [rotor menu](https://github.com/trussworks/accessibility/blob/master/README.md#how-to-use-the-rotor-menu) for landmarks, page heading structure and links
- [ ] Used a browser a11y tool to check for issues (WAVE, axe, ANDI or Accessibility addon tab for Storybook)
- [ ] Requested a design review for user-facing changes
- For any new migrations/schema changes:
- [ ] Followed guidelines for zero-downtime deploys

### As code reviewer(s), I have

- [ ] Pulled this branch locally and tested it
- [ ] Reviewed this code and left comments
- [ ] Checked that all code is adequately covered by tests
- [ ] Checked that the E2E test build is not failing
- [ ] Made it clear which comments need to be addressed before this work is merged
- [ ] Considered marking this as accepted even if there are small changes needed
- Performed [a11y testing](https://github.com/trussworks/accessibility/blob/master/sample_a11y_testing_process.md):
- [ ] Checked responsiveness in mobile, tablet, and desktop
- [ ] Checked keyboard navigability
- [ ] Tested with [VoiceOver](https://dequeuniversity.com/screenreaders/voiceover-keyboard-shortcuts) in Safari
- [ ] Checked VO's [rotor menu](https://github.com/trussworks/accessibility/blob/master/README.md#how-to-use-the-rotor-menu) for landmarks, page heading structure and links
- [ ] Used a browser a11y tool to check for issues (WAVE, axe, ANDI or Accessibility addon tab for Storybook)

### As a designer reviewer, I have

- [ ] Checked in the design translated visually
- [ ] Checked behavior
- [ ] Checked different states (empty, one, some, error)
- [ ] Checked for landmarks, page heading structure, and links
- [ ] Tried to break the intended flow
- Performed [a11y testing](https://github.com/trussworks/accessibility/blob/master/sample_a11y_testing_process.md):
- [ ] Checked responsiveness in mobile, tablet, and desktop
- [ ] Checked keyboard navigability
- [ ] Tested with [VoiceOver](https://dequeuniversity.com/screenreaders/voiceover-keyboard-shortcuts) in Safari
- [ ] Checked VO's [rotor menu](https://github.com/trussworks/accessibility/blob/master/README.md#how-to-use-the-rotor-menu) for landmarks, page heading structure and links
- [ ] Used a browser a11y tool to check for issues (WAVE, axe, ANDI or Accessibility addon tab for Storybook)

### As a test user, I have

- Run through the [Test Script](hhttps://docs.google.com/spreadsheets/d/1eV8UK0aJZ0qrzjnXf5SJ_uRiV7bpsj3yrhRFEkjOvV4/edit?usp=sharing):
- [ ] On commercial internet in IE11
- [ ] On commercial internet in Firefox
- [ ] On commercial internet in Chrome
- [ ] On commercial internet in Safari
- [ ] On NIPR in IE11
- [ ] On NIPR in Firefox
- [ ] On NIPR in Chrome
- [ ] On NIPR in Safari
- [ ] On a mobile device in Firefox
- [ ] On a mobile device in Chrome
- [ ] On a mobile device in Safari
- [ ] Added any anomalous behavior to this PR
- [ ] Created/modified automated [E2E tests](https://github.com/USSF-ORBIT/ussf-portal)
- [ ] Followed guidelines for zero-downtime deploys, if applicable
- [ ] Use [ANDI](https://www.ssa.gov/accessibility/andi/help/install.html) to check for basic a11y issues

### As a reviewer, I have

Check out our [How to review a pull request](https://github.com/USSF-ORBIT/ussf-portal/blob/main/docs/how-to/review-pull-request.md) document.

---

Expand Down

0 comments on commit 365fab8

Please sign in to comment.