Skip to content
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

Merged
merged 5 commits into from
Aug 21, 2023
Merged

Docs: Reword PR template #23810

merged 5 commits into from
Aug 21, 2023

Conversation

vanessayuenn
Copy link
Contributor

@vanessayuenn vanessayuenn commented Aug 11, 2023

What I did

Edited the PR template. More specifically, I:

  • Moved some sections around to clarify things
  • Made the testing section mandatory
  • Added description for each PR label

How to test

No test necessary! Just 👀

Checklist

  • 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
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

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"]

🦋 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>

- Made testing section mandatory
- Moved some sections around to clarify things
- Added description for each PR label
@vanessayuenn vanessayuenn added ci:docs Run the CI jobs for documentation checks only. documentation labels Aug 11, 2023
@yannbf
Copy link
Member

yannbf commented Aug 14, 2023

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?


-->
- [ ] Make sure this PR contains **one** of the labels below:
- `cleanup`: Minor cleanup style change. Will not show up in release changelog.
Copy link
Contributor

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).

@vanessayuenn
Copy link
Contributor Author

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?

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.

@vanessayuenn vanessayuenn merged commit e2c0069 into next Aug 21, 2023
15 checks passed
@vanessayuenn vanessayuenn deleted the vy/reword-pr-template branch August 21, 2023 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants