diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..456f8e59ac --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,56 @@ + + +## Describe your changes + + + + +| Before | After | +| -------------------- | ------------------- | +| Paste original image | Paste changed image | + +## Checklist before requesting a review + +- [ ] Is the PR title and/or first commit semantic? +- [ ] 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? + +## Checklist if you are converting JS files to TS + + + +- [ ] 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 + +- [ ] Are the code blocks in the components `tsx` spaced correctly? +- [ ] Did you run all the tests? +- [ ] Did you run `flow check`? +- [ ] 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`? + + + + +## Approved? add the ready-to-merge label to your PR