chore(template): Added PR template #2993
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| <!-- Remove the sections that are not applicable --> | ||
|
|
||
| ## Describe your changes | ||
|
|
||
| <!-- Descriptions can consist of describing the change and/or images of the change --> | ||
| <!-- Refrain from posting anything that refers to internal information --> | ||
|
|
||
| | Before | After | | ||
| | -------------------- | ------------------- | | ||
| | Paste original image | Paste changed image | | ||
|
|
||
| ## Checklist before requesting a review | ||
|
|
||
| - [ ] Is the PR title and/or first commit semantic? <!-- refer: https://github.com/box/box-ui-elements/blob/master/CONTRIBUTING.md#commit-types --> | ||
| - [ ] Have you checked if the tests pass? | ||
| - [ ] Did the build on CircleCi pass? | ||
| - [ ] Are the checks on GitHub passing? | ||
|
|
||
| ## Checklist making a change | ||
|
|
||
| - [ ] Did you verify the changes against the mocks? | ||
| - [ ] Are your changes a11y compliant? | ||
| - [ ] Are your changes responsive? (if applicable) | ||
| - [ ] Did you test your changes in a parent app? | ||
|
|
||
| ## Checklist if you are adding new stories | ||
|
|
||
| - [ ] Have you run `yarn start:storybook` to manually test your changes? | ||
| - [ ] Did you ensure you only added necessary changes for adding a story? | ||
|
Contributor
There was a problem hiding this comment. I'm confused about what this one is asking |
||
|
|
||
| ## Checklist if you are converting JS files to TS | ||
|
Contributor
Author
There was a problem hiding this comment. Write new storybook/TS readmes ?
Contributor
There was a problem hiding this comment. potentially link them instead of including them here directly |
||
|
|
||
| <!-- Please follow the internal guide for conversion steps --> | ||
|
|
||
| - [ ] Did you delete the old snapshots if there were any? | ||
| - [ ] 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 are in `/components`, did you update `/components/index.ts` with exports and new components | ||
|
|
||
| ## Checklist JS -> TS before requesting a review | ||
|
Contributor
There was a problem hiding this comment. maybe we could merge this with the previous section: |
||
|
|
||
| - [ ] Are the code blocks in the components `tsx` spaced correctly? | ||
| - [ ] Did you run all the tests? | ||
| - [ ] Did you run `flow check`? | ||
|
greg-in-a-box marked this conversation as resolved.
|
||
| - [ ] Did you run `yarn lint`? | ||
| - [ ] If a story was added in conjunction with the conversion, did you run `yarn start:storybook`? | ||
| - [ ] Did you update `styleguide.config.js`? | ||
|
|
||
| <!-- Faqs --> | ||
| <!-- | ||
| 1. If everything is green except the mergify check, it is possible you have changes requests by someone or missing approvals | ||
| 2. If your build failed in CircleCi due to an e2e then rebuild a couple of times before reporting the issues | ||
| --> | ||
|
|
||
| ## Approved? add the ready-to-merge label to your PR | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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