-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New Checklist for PR Template (#2949)
* new checklist for pr template * white space * put accessibility in General UX section * add browserstack note * add storybook example * styling * more styling * typo
- Loading branch information
1 parent
97f9207
commit 5fbdb31
Showing
1 changed file
with
42 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,49 +1,54 @@ | ||
| _Please request review from `@zooniverse/frontend` team or an individual member of that team._ | ||
|
|
||
| Package: | ||
| ## Package | ||
|
|
||
| Closes # . | ||
| ## Linked Issue and/or Talk Post | ||
|
|
||
| ## Describe your changes | ||
|
|
||
| ## Describe your changes: | ||
|
|
||
| <em>Helpful explanations that will make your reviewer happy:</em> | ||
| ## How to Review | ||
| _Helpful explanations that will make your reviewer happy:_ | ||
| - What Zooniverse project should my reviewer use to review UX? | ||
| - What user actions should my reviewer step through to review this PR? | ||
| - Which storybook stories should be reviewed? | ||
| - Are there plans for follow up PR’s to further fix this bug or develop this feature? | ||
|
|
||
|
|
||
| # Review Checklist | ||
| # Checklist | ||
| _PR Creator - Please cater the checklist to fit the review needed for your code changes._ | ||
| _PR Reviewer - Use the checklist during your review. Each point should be checkmarked or discussed before PR approval._ | ||
|
|
||
| ## General | ||
|
|
||
| - [ ] Are the tests passing locally and on Travis? | ||
| - [ ] Is the documentation up to date? | ||
|
|
||
| ## Components | ||
| - [ ] Has a storybook story been created or updated? | ||
| - [ ] Is the component accessible? | ||
| - [ ] Can it be used with a screen reader? [BBC guide to testing with VoiceOver](https://bbc.github.io/accessibility-news-and-you/accessibility-and-testing-with-voiceover-os.html) | ||
| - [ ] Can it be used from the keyboard? [WebAIM guide to keyboard testing](https://webaim.org/techniques/keyboard/#testing) | ||
| - [ ] Is it passing accessibility checks in the storybook? | ||
|
|
||
| ## Apps | ||
|
|
||
| - [ ] Does it work in all major browsers: Firefox, Chrome, Edge, Safari? | ||
| - [ ] Does it work on mobile? | ||
| - [ ] Can you `yarn panic && yarn bootstrap` or `docker-compose up --build` and app works as expected? | ||
|
|
||
| ## Publishing | ||
|
|
||
| - [ ] Is the changelog updated? | ||
| - [ ] Are the dependencies updated for apps and libraries that are using the newly published library? | ||
|
|
||
| ## Post-merging | ||
|
|
||
| - [ ] Did the app deploy to https://frontend.preview.zooniverse.org/projects/:project-name/:owner or https://frontend.preview.zooniverse.org/about? | ||
| - [ ] Is the new feature working or bug now fixed? | ||
| - [ ] Is there a Talk or blog post written to announce the new feature(s)? | ||
| - [ ] Is the design working across browsers (Firefox, Chrome, Edge, Safari) and mobile? | ||
| - [ ] Is this approved by our designer? | ||
| - [ ] Is this ready for production deployment? | ||
| - [ ] Tests are passing locally and on Github | ||
| - [ ] Documentation is up to date and changelog has been updated if appropriate | ||
| - [ ] You can `yarn panic && yarn bootstrap` or `docker-compose up --build` and FEM works as expected | ||
| - [ ] FEM works in all major desktop browsers: Firefox, Chrome, Edge, Safari (Use Browserstack account as needed) | ||
| - [ ] FEM works in a mobile browser | ||
|
|
||
| ## General UX | ||
| Example Staging Project: [i-fancy-cats](https://local.zooniverse.org:3000/projects/brooke/i-fancy-cats) | ||
| - [ ] All pages of a FEM project load: Home Page, Classify Page, and About Pages | ||
| - [ ] Can submit a classification | ||
| - [ ] Can sign-in and sign-out | ||
| - [ ] The component is accessible | ||
| - Can be used with a screen reader [BBC guide to VoiceOver](https://bbc.github.io/accessibility-news-and-you/accessibility-and-testing-with-voiceover-os.html) | ||
| - Can be used from the keyboard [WebAIM guide to keyboard testing](https://webaim.org/techniques/keyboard/#testing) | ||
| - It is passing accessibility checks in the storybook | ||
|
|
||
|
|
||
| ## Bug Fix | ||
| - [ ] The PR creator has listed user actions to use when testing if bug is fixed | ||
| - [ ] The bug is fixed | ||
| - [ ] Unit tests are added or updated | ||
|
|
||
| ## New Feature | ||
| - [ ] The PR creator has listed user actions to use when testing the new feature | ||
| - [ ] Unit tests are included for the new feature | ||
| - [ ] A storybook story has been created or updated | ||
| - Example of SlideTutorial [component](https://github.com/zooniverse/front-end-monorepo/blob/master/packages/lib-classifier/src/components/Classifier/components/SlideTutorial/SlideTutorial.js) with docgen comments, and its [story](https://zooniverse.github.io/front-end-monorepo/@zooniverse/classifier/index.html?path=/docs/other-slidetutorial--default) | ||
|
|
||
| ## Refactoring | ||
| - [ ] The PR creator has described the reason for refactoring | ||
| - [ ] The refactored component(s) continue to work as expected | ||
|
|
||
| ## Maintenance | ||
| - [ ] If not from dependabot, the PR creator has described the update (major, minor, or patch version, changelog) |