-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Reword PR template #23810
Docs: Reword PR template #23810
Conversation
- Made testing section mandatory - Moved some sections around to clarify things - Added description for each PR label
This looks really good! I just wonder about the wording for folks who make documentation changes only, and might be confused if they have to tick the checkboxes. Can you add something about documentation PRs? |
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
||
--> | ||
- [ ] Make sure this PR contains **one** of the labels below: | ||
- `cleanup`: Minor cleanup style change. Will not show up in release changelog. |
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.
I love that these are briefly described now! ❤️
Are these in any particular order? I suggest either most-common first or alphabetical (keeping the non-changelog impacting ones grouped together, as you've done).
Co-authored-by: Kyle Gach <kyle.gach@gmail.com>
I thought about it but ultimately decided it's simpler to offer one protocol instead of "if code changes, do this, if docs changes, do something else". Docs-only contributions can just not check any of the checkboxes, like how it is currently. |
What I did
Edited the PR template. More specifically, I:
How to test
No test necessary! Just 👀
Checklist
MIGRATION.MD
Maintainers
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
["cleanup", "BREAKING CHANGE", "feature request", "bug", "build", "documentation", "maintenance", "dependencies", "other"]
🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/core
team here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>