[skip changelog] Fix contributing instructions re: skipping changelog #916
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The arduino/arduino-cli repository's automatic changelog generation system adds a changelog item for every commit, except those that start with "[skip changelog]". This is useful for keeping the changelog to only mentioning the changes that are significant to the user. All pull requests are merged using GitHub's "Squash & Merge" feature. The behavior of "Squash & Merge": - If the PR only contains a single commit, the pre-filled squash commit message is taken from the commit, not the PR. - If the PR contains multiple commits, the prefilled squash commit title is the PR title. This means that a PR will end up in the changelog against the wishes of the contributor when all of the following occur: - The PR author followed the instructions and only added "[skip changelog]" to the PR title. - The PR only contains a single commit. - The maintainer who merges the PR uses the pre-filled commit message provided by GitHub. The first two conditions are common. There is evidence that the third will also be common. To make the instructions as easy as possible to follow, the contributor is now instructed to add "[skip changelog]" to both the commit message and PR title, even though it is really only necessary to add it to one or the other, depending on the conditions.
rsora
approved these changes
Sep 7, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
before creating one)
our contributing guidelines
Docs update.
The arduino/arduino-cli repository's automatic changelog generation system adds a changelog item for every commit, except those that start with "[skip changelog]". This is useful for keeping the changelog to only mentioning the changes that are significant to the user.
All pull requests are merged using GitHub's "Squash & Merge" feature.
The behavior of "Squash & Merge":
This means that a PR will end up in the changelog against the wishes of the contributor when all of the following occur:
The first two conditions are common. There is evidence that the third will also be common.
To make the instructions as easy as possible to follow, the contributor is now instructed to add "[skip changelog]" to both the commit message and PR title, even though it is really only necessary to add it to one or the other, depending on the conditions.
No