From 585261b514c8d086a677cba44ea86bf093ebcdc4 Mon Sep 17 00:00:00 2001 From: Greg Wong Date: Mon, 15 Aug 2022 17:32:56 -0400 Subject: [PATCH 1/2] chore(template): Added PR template --- .github/pull_request_template.md | 43 ++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..a6b2bf9af1 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,43 @@ + + +## Describe your changes + + + +## Checklist before requesting a review + +- [ ] Is the PR title and first commit semantic? +- [ ] Have you checked if the test pass? +- [ ] Do the builds on github pass? + +## Checklist if you are making UI changes + +- [ ] Did you verify the changes against the mocks? +- [ ] Are your changes a11y compliant? +- [ ] Are your changes responsive? (if applicable) + +## Checklist if you are adding new stories + +- [ ] 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? + +## 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 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`? From 8db140a5e405b9789fb601a2f7415413a1ff5f41 Mon Sep 17 00:00:00 2001 From: Greg Wong Date: Fri, 18 Nov 2022 12:01:43 -0500 Subject: [PATCH 2/2] chore(template): feedback --- .github/pull_request_template.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a6b2bf9af1..456f8e59ac 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -3,24 +3,29 @@ ## Describe your changes + + +| Before | After | +| -------------------- | ------------------- | +| Paste original image | Paste changed image | ## Checklist before requesting a review -- [ ] Is the PR title and first commit semantic? -- [ ] Have you checked if the test pass? -- [ ] Do the builds on github pass? +- [ ] 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 if you are making UI changes +## 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 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` +- [ ] 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 @@ -31,7 +36,7 @@ - [ ] 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 +- [ ] 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 @@ -41,3 +46,11 @@ - [ ] 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