From de23161ecfff38ce56dc41ae2433320c6f1cce1f Mon Sep 17 00:00:00 2001 From: Vanessa Yuen <6842965+vanessayuenn@users.noreply.github.com> Date: Fri, 11 Aug 2023 17:25:24 +0200 Subject: [PATCH 1/3] Reword PR template - Made testing section mandatory - Moved some sections around to clarify things - Added description for each PR label --- .github/PULL_REQUEST_TEMPLATE.md | 54 ++++++++++++++++++++++---------- 1 file changed, 37 insertions(+), 17 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f24147199aeb..0228aa268cd2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,12 +1,32 @@ -Closes # + +Thank you for contributing to Storybook! Please submit all PRs to the `next` branch unless they are specific to the current release. Storybook maintainers cherry-pick bug and documentation fixes into the `main` branch as part of the release process, so you shouldn't need to worry about this. For additional guidance: https://storybook.js.org/docs/react/contribute/how-to-contribute + +--> ## What I did -## How to test + + +Closes # + +## Checklist for Contributors + +### Testing + + + +#### The changes in this PR are covered in the following automated tests: +- [ ] stories +- [ ] unit tests +- [ ] integration tests +- [ ] end-to-end tests + +#### Manual testing + +_This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!_ -## Checklist +### Documentation - + -- [ ] Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests) -- [ ] Make sure to add/update documentation regarding your changes +- [ ] Add or update documentation reflecting your changes - [ ] If you are deprecating/removing a feature, make sure to update [MIGRATION.MD](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md) -#### Maintainers +## Checklist for Maintainers - [ ] When this PR is ready for testing, make sure to add `ci:normal`, `ci:merged` or `ci:daily` GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in `code/lib/cli/src/sandbox-templates.ts` -- [ ] Make sure this PR contains **one** of the labels below. - -`["cleanup", "BREAKING CHANGE", "feature request", "bug", "build", "documentation", "maintenance", "dependencies", "other"]` - - +- [ ] Make sure this PR contains **one** of the labels below: +- `cleanup`: Minor cleanup style change. Will not show up in release changelog. +- `build`: Internal-facing build tooling & test updates. Will not show up in release changelog. +- `documentation`: Documentation **only** changes. Will not show up in release changelog. +- `maintenance`: User-facing maintenance tasks. +- `dependencies`: Upgrading (sometimes downgrading) dependencies. +- `BREAKING CHANGE`: Changes that break compatibility in some way with current major version. +- `feature request`: Introducing a new feature. +- `bug`: Internal changes that fixes incorrect behavior. +- `other`: Changes that don't fit in the above categories. ### 🦋 Canary release From f0222ec212d95d127c9730d905684fdaa6aa288d Mon Sep 17 00:00:00 2001 From: Vanessa Yuen <6842965+vanessayuenn@users.noreply.github.com> Date: Mon, 21 Aug 2023 17:22:13 +0200 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Kyle Gach --- .github/PULL_REQUEST_TEMPLATE.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0228aa268cd2..48e6891697b2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -48,15 +48,18 @@ _This section is mandatory for all contributions. If you believe no manual test - [ ] When this PR is ready for testing, make sure to add `ci:normal`, `ci:merged` or `ci:daily` GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in `code/lib/cli/src/sandbox-templates.ts` - [ ] Make sure this PR contains **one** of the labels below: -- `cleanup`: Minor cleanup style change. Will not show up in release changelog. -- `build`: Internal-facing build tooling & test updates. Will not show up in release changelog. -- `documentation`: Documentation **only** changes. Will not show up in release changelog. -- `maintenance`: User-facing maintenance tasks. -- `dependencies`: Upgrading (sometimes downgrading) dependencies. -- `BREAKING CHANGE`: Changes that break compatibility in some way with current major version. -- `feature request`: Introducing a new feature. -- `bug`: Internal changes that fixes incorrect behavior. -- `other`: Changes that don't fit in the above categories. +
+ Available labels + - `cleanup`: Minor cleanup style change. Will not show up in release changelog. + - `build`: Internal-facing build tooling & test updates. Will not show up in release changelog. + - `documentation`: Documentation **only** changes. Will not show up in release changelog. + - `maintenance`: User-facing maintenance tasks. + - `dependencies`: Upgrading (sometimes downgrading) dependencies. + - `BREAKING CHANGE`: Changes that break compatibility in some way with current major version. + - `feature request`: Introducing a new feature. + - `bug`: Internal changes that fixes incorrect behavior. + - `other`: Changes that don't fit in the above categories. +
### 🦋 Canary release From 7127ca049f1a519aff86cac16b22f615bddb6047 Mon Sep 17 00:00:00 2001 From: Vanessa Yuen <6842965+vanessayuenn@users.noreply.github.com> Date: Mon, 21 Aug 2023 15:43:55 +0000 Subject: [PATCH 3/3] updates based on feedback --- .github/PULL_REQUEST_TEMPLATE.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 48e6891697b2..ba472744a8f1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,17 +1,18 @@ +Closes # + + + + ## What I did - - -Closes # - ## Checklist for Contributors ### Testing @@ -50,15 +51,17 @@ _This section is mandatory for all contributions. If you believe no manual test - [ ] Make sure this PR contains **one** of the labels below:
Available labels - - `cleanup`: Minor cleanup style change. Will not show up in release changelog. - - `build`: Internal-facing build tooling & test updates. Will not show up in release changelog. - - `documentation`: Documentation **only** changes. Will not show up in release changelog. + + - `bug`: Internal changes that fixes incorrect behavior. - `maintenance`: User-facing maintenance tasks. - `dependencies`: Upgrading (sometimes downgrading) dependencies. - - `BREAKING CHANGE`: Changes that break compatibility in some way with current major version. + - `build`: Internal-facing build tooling & test updates. Will not show up in release changelog. + - `cleanup`: Minor cleanup style change. Will not show up in release changelog. + - `documentation`: Documentation **only** changes. Will not show up in release changelog. - `feature request`: Introducing a new feature. - - `bug`: Internal changes that fixes incorrect behavior. + - `BREAKING CHANGE`: Changes that break compatibility in some way with current major version. - `other`: Changes that don't fit in the above categories. +
### 🦋 Canary release