chore: add commitlint to enforce commit structure#16
Merged
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
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.
This PR adds commitlint for both locally and on CI. The goal here is to enforce conventional commits throughout all the commits, which has t he following benefits:
Automated Changelog Generation: This is the biggest win. Tools can parse these messages and instantly generate a beautiful, categorized changelog. The manual step in our "ship" tool is completely eliminated.
Clearer Git History: The history becomes a high-level story of the project's evolution. Anyone can scan the commit log and immediately understand the nature of each change without reading the code.
Automatic Semantic Versioning: The commit type directly maps to Semantic Versioning rules (fix = PATCH bump, feat = MINOR bump, feat! or BREAKING CHANGE: = MAJOR bump). This removes the guesswork from versioning.
Improved Code Review: It encourages developers to create smaller, more focused PRs. A PR should ideally contain commits of a similar type, making it easier for reviewers to understand its purpose.
Enabling Powerful Tooling: It unlocks an entire ecosystem of tools, including the one we will propose next: release-please.
This PR adds integration in different cases: