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

Add changeset command to CONTRIBUTING.md #884

Merged
merged 2 commits into from
Oct 12, 2023

Conversation

HiDeoo
Copy link
Member

@HiDeoo HiDeoo commented Oct 12, 2023

What kind of changes does this PR include?

  • Something else!

Description

This PR adds a new small section to the CONTRIBUTING.md file that could be easily linked in PRs that need a changeset.

It contains a small description of changesets and when they should be used, with a link to the changeset docs describing in details how to add one in a monorepo and also showing the command to use.

@changeset-bot
Copy link

changeset-bot bot commented Oct 12, 2023

⚠️ No Changeset found

Latest commit: e748e04

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@netlify
Copy link

netlify bot commented Oct 12, 2023

👷 Deploy Preview for astro-starlight processing.

Name Link
🔨 Latest commit e748e04
🔍 Latest deploy log https://app.netlify.com/sites/astro-starlight/deploys/6527fcb2ae16f40008c1ab4f

Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks for documenting that.

I will say that I usually don’t require contributors to do this themselves. It’s kind of a detail in our release system, so I consider it something maintainers can do as a courtesy unless for some reason we don’t have the information to write a good changeset for a contributor’s changes.

@HiDeoo HiDeoo merged commit 8e10f9a into withastro:main Oct 12, 2023
9 checks passed
@HiDeoo
Copy link
Member Author

HiDeoo commented Oct 12, 2023

I will say that I usually don’t require contributors to do this themselves. It’s kind of a detail in our release system, so I consider it something maintainers can do as a courtesy unless for some reason we don’t have the information to write a good changeset for a contributor’s changes.

Definitely, I usually mention changeset in PR review when I see that it's missing so it's tracked, but only in a simple comment and never in a required change comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants