docs: Add documentation about conventional commits #12971
Merged
Conversation
This file contains 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
github-actions
bot
added
the
documentation
alamb
approved these changes
Oct 16, 2024
| looking for titles starting with prefixes such as `fix:`, `feat:`, `docs:`, or `chore:`. We do not enforce this | ||
| convention but encourage its use if you want your PR to feature in the correct section of the changelog. | ||
|
|
||
| The change log generator will also look at GitHub labels such as `bug`, `enhancement`, or `api change`, and labels |
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.
Which issue does this PR close?
N/A
Rationale for this change
We generate changelogs based on PR titles where PRs following the conventional commits specification, and also based on labels associated with PRs, but we did not documentation for this process.
What changes are included in this PR?
This PR adds documentation.
Are these changes tested?
Are there any user-facing changes?