-
Notifications
You must be signed in to change notification settings - Fork 305
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(template): Added PR template #2993
base: master
Are you sure you want to change the base?
Conversation
.github/pull_request_template.md
Outdated
- [ ] Did you convert the props to an interface? | ||
- [ ] Did you fix the existing tests? | ||
- [ ] Did you fill in the missing types? | ||
- [ ] If the files you've migrated in `/components`, did you update `/components/index.ts` with exports and new components |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think there's a grammar error here, I think you might have meant to say "If the files you've migrated are in /components
"
- [ ] Did you verify the changes against the mocks? | ||
- [ ] Are your changes a11y compliant? | ||
- [ ] Are your changes responsive? (if applicable) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe we should ask them to test the changes in both storybook and at least one parent app
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
actually maybe we should ask them to do that for ANY change, not just UI ones
- [ ] Did you fill in the missing types? | ||
- [ ] If the files you've migrated in `/components`, did you update `/components/index.ts` with exports and new components | ||
|
||
## Checklist JS -> TS before requesting a review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe we could merge this with the previous section: Checklist if you are converting JS files to TS
.github/pull_request_template.md
Outdated
|
||
## Checklist before requesting a review | ||
|
||
- [ ] Is the PR title and first commit semantic? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
at minimum, the title needs to be semantic. I'm not 100% sure about the commit though.
this might not fit the format but should we link the commit guidelines? unnecessary if we're already doing that somewhere else. https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits
.github/pull_request_template.md
Outdated
## Checklist before requesting a review | ||
|
||
- [ ] Is the PR title and first commit semantic? | ||
- [ ] Have you checked if the test pass? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- [ ] Have you checked if the test pass? | |
- [ ] Have you checked if the tests pass? |
.github/pull_request_template.md
Outdated
|
||
- [ ] Is the PR title and first commit semantic? | ||
- [ ] Have you checked if the test pass? | ||
- [ ] Do the builds on github pass? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- [ ] Do the builds on github pass? | |
- [ ] Do the builds on GitHub pass? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
although should this be singular? Does the build on GitHub pass?
- [ ] Have you ran `yarn start:storybook` to manually test your story? | ||
- [ ] Have you added a test for the stories that you added? | ||
- [ ] Have you ran `yarn test:visuals` | ||
- [ ] Did you ensure you only added necessary changes for adding a story? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm confused about what this one is asking
- [ ] Have you run `yarn start:storybook` to manually test your changes? | ||
- [ ] Did you ensure you only added necessary changes for adding a story? | ||
|
||
## Checklist if you are converting JS files to TS |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Write new storybook/TS readmes ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
potentially link them instead of including them here directly
No description provided.