From b7ec2c0d2db5cb9ed288b31ee31e30166dd7bdf7 Mon Sep 17 00:00:00 2001 From: Ben Siggery <14013357+siggerzz@users.noreply.github.com> Date: Thu, 4 Apr 2024 14:14:16 +0100 Subject: [PATCH] chore(pie-monorepo): DSW-1823 update PR template to be dynamic based on scope of change (#1345) * feat(pie-monorepo): DSW-1823 test pr templates * chore(pie-monorepo): DSW-1823 update PR template to be dynamic based on scope of change * chore(pie-monorepo): DSW-1823 update templates * chore(pie-monorepo): DSW-1823 update yarn lock * chore(pie-monorepo): DSW-1823 fix yarn lock * fix rebase * chore(pie-monorepo): DSW-1823 update template * chore(pie-monorepo): DSW-1823 update template * chore(pie-monorepo): DSW-1823 change format * chore(pie-monorepo): DSW-1823 update wording * chore(pie-monorepo): DSW-1823 rebase * chore(pie-monorepo): DSW-1823 correct changes * format(pie-monorepo): DSW-1823 remove periods * chore(pie-monorepo): DSW-1823 pR suggestions * chore(pie-monorepo): DSW-1823 add link to label creation page --- .../PULL_REQUEST_TEMPLATE/docs_template.md | 19 +++++++++++++++++ .../new_component_template.md | 21 +++++++++++++++++++ .github/pull_request_template.md | 20 ++++++++++++------ yarn.lock | 18 ++++++++-------- 4 files changed, 63 insertions(+), 15 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE/docs_template.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/new_component_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/docs_template.md b/.github/PULL_REQUEST_TEMPLATE/docs_template.md new file mode 100644 index 0000000000..bd1bb88196 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/docs_template.md @@ -0,0 +1,19 @@ +## Describe your changes (can list changeset entries if preferable) + + +## Author Checklist (complete before requesting a review) +- [ ] I have performed a self-review of my code +- [ ] I have added thorough tests where applicable (unit / component / visual) +- [ ] I have reviewed the Docs site preview +- [ ] If there are visual test updates, I have reviewed them properly before approving + +## Reviewer checklists (complete before approving) +### Reviewer 1 +- [ ] I have reviewed the Docs site preview +- [ ] If new links have been added, I have tested them in the preview +- [ ] If there are visual test updates, I have reviewed them + +### Reviewer 2 +- [ ] I have reviewed the Docs site preview +- [ ] If new links have been added, I have tested them in the preview +- [ ] If there are visual test updates, I have reviewed them diff --git a/.github/PULL_REQUEST_TEMPLATE/new_component_template.md b/.github/PULL_REQUEST_TEMPLATE/new_component_template.md new file mode 100644 index 0000000000..121285ea56 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/new_component_template.md @@ -0,0 +1,21 @@ +## Describe your changes (can list changeset entries if preferable) + + +## Author Checklist (complete before requesting a review) +- [ ] I have performed a self-review of my code +- [ ] I have added thorough tests where applicable (unit / component / visual) +- [ ] If visual tests are required for the component, I have created a project in Percy +- [ ] I have reviewed the `PIE Storybook`/`PIE Docs` PR preview +- [ ] I have reviewed visual test updates properly before approving +- [ ] If changes will affect consumers of the package, I have created a changeset entry. +- [ ] If a changeset file has been created, I have used the `/snapit` functionality to test my changes in a consuming application +- [ ] I have [created a new label](https://github.com/justeattakeaway/pie/issues/labels) and added it to the [PR Labeler workflow](https://github.com/justeattakeaway/pie/blob/main/.github/project-labeler.yml) + +## Reviewer checklists (complete before approving) +### Reviewer 1 +- [ ] I have reviewed the `PIE Storybook`/`PIE Docs` PR preview +- [ ] If there are visual test updates, I have reviewed them + +### Reviewer 2 +- [ ] I have reviewed the `PIE Storybook`/`PIE Docs` PR preview +- [ ] If there are visual test updates, I have reviewed them \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ea8bfc7e67..a7825aebb8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,18 +1,26 @@ +Please click the `Preview` tab and select a different PR template if your change isn't for an existing web component. + +[PIE Docs Template](?expand=1&template=docs_template.md) +[New Web Component Template](?expand=1&template=new_component_template.md) + +═══════════════════════════════════════════════════════════ + ## Describe your changes (can list changeset entries if preferable) ## Author Checklist (complete before requesting a review) - [ ] I have performed a self-review of my code -- [ ] If it is a core feature, I have added thorough tests -- [ ] If it is a `PIE Docs` change, I have reviewed the Docs site preview -- [ ] If it is a component change, I have reviewed the Storybook preview -- [ ] If there are visual test updates, I have reviewed them properly before approving +- [ ] I have added thorough tests where applicable (unit / component / visual) +- [ ] I have reviewed the `PIE Storybook`/`PIE Docs` PR preview +- [ ] I have reviewed visual test updates properly before approving +- [ ] If changes will affect consumers of the package, I have created a changeset entry. +- [ ] If a changeset file has been created, I have used the `/snapit` functionality to test my changes in a consuming application ## Reviewer checklists (complete before approving) ### Reviewer 1 -- [ ] If it is a `PIE Docs` change, I have reviewed the PR preview +- [ ] I have reviewed the `PIE Storybook`/`PIE Docs` PR preview - [ ] If there are visual test updates, I have reviewed them ### Reviewer 2 -- [ ] If it is a `PIE Docs` change, I have reviewed the PR preview +- [ ] I have reviewed the `PIE Storybook`/`PIE Docs` PR preview - [ ] If there are visual test updates, I have reviewed them diff --git a/yarn.lock b/yarn.lock index e1477c5797..c08de02e94 100644 --- a/yarn.lock +++ b/yarn.lock @@ -30276,35 +30276,35 @@ __metadata: linkType: hard "postcss-modules-extract-imports@npm:^3.0.0": - version: 3.0.0 - resolution: "postcss-modules-extract-imports@npm:3.0.0" + version: 3.1.0 + resolution: "postcss-modules-extract-imports@npm:3.1.0" peerDependencies: postcss: ^8.1.0 - checksum: 4b65f2f1382d89c4bc3c0a1bdc5942f52f3cb19c110c57bd591ffab3a5fee03fcf831604168205b0c1b631a3dce2255c70b61aaae3ef39d69cd7eb450c2552d2 + checksum: b9192e0f4fb3d19431558be6f8af7ca45fc92baaad9b2778d1732a5880cd25c3df2074ce5484ae491e224f0d21345ffc2d419bd51c25b019af76d7a7af88c17f languageName: node linkType: hard "postcss-modules-local-by-default@npm:^4.0.0, postcss-modules-local-by-default@npm:^4.0.4": - version: 4.0.4 - resolution: "postcss-modules-local-by-default@npm:4.0.4" + version: 4.0.5 + resolution: "postcss-modules-local-by-default@npm:4.0.5" dependencies: icss-utils: ^5.0.0 postcss-selector-parser: ^6.0.2 postcss-value-parser: ^4.1.0 peerDependencies: postcss: ^8.1.0 - checksum: 578b955b0773147890caa88c30b10dfc849c5b1412a47ad51751890dba16fca9528c3ab00a19b186a8c2c150c2d08e2ce64d3d907800afee1f37c6d38252e365 + checksum: ca9b01f4a0a3dfb33e016299e2dfb7e85c3123292f7aec2efc0c6771b9955648598bfb4c1561f7ee9732fb27fb073681233661b32eef98baab43743f96735452 languageName: node linkType: hard "postcss-modules-scope@npm:^3.0.0, postcss-modules-scope@npm:^3.1.1": - version: 3.1.1 - resolution: "postcss-modules-scope@npm:3.1.1" + version: 3.2.0 + resolution: "postcss-modules-scope@npm:3.2.0" dependencies: postcss-selector-parser: ^6.0.4 peerDependencies: postcss: ^8.1.0 - checksum: 9e9d23abb0babc7fa243be65704d72a5a9ceb2bded4dbaef96a88210d468b03c8c3158c197f4e22300c851f08c6fdddd6ebe65f44e4c34448b45b8a2e063a16d + checksum: 2ffe7e98c1fa993192a39c8dd8ade93fc4f59fbd1336ce34fcedaee0ee3bafb29e2e23fb49189256895b30e4f21af661c6a6a16ef7b17ae2c859301e4a4459ae languageName: node linkType: hard