Repository navigation
docs: align commit conventions with commitlint and explain the changelog - #1050
Merged
Merged
Conversation
|
🚀 Preview deployed: http://phoenix-pr-1050.surge.sh Built from 072ddba. |
Member
|
Thank you very much - this is great! |
This branch was successfully deployed
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
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.
Part of #424
Old behavior:
CONTRIBUTING.mdlisted amisccommit type that commitlint (@commitlint/config-conventional) rejects, listed only two scopes, and did not say how commits, PR titles and the changelog relate.New behavior: the documented types match what CI accepts, the scope list notes that package names are used, and a short section explains that the PR title is validated, becomes the commit message on squash merge, and that merge commits do not produce changelog entries.
Changes:
The workflows already validate PR titles and commits, so this only documents the current setup. I left the issue open in case maintainers want more, for example a PR-based changelog tool.