Install and configure commitlint and Lefthook #868
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
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.
To streamline the release process for this library, we are introducing Conventional Commits to automate the release process. Upon merging this Pull Request, Conventional Commits will be enforced locally through the use of Git Hooks (Lefthook) and commitlint.
We have outlined two phases for the integration of Conventional Commits:
This PR marks the beginning of the enforcement phase, where we implement commitlint to ensure adherence to the standard on a local level. The
commitlint.config.jsfile includes several rules that are being enforced, which can be reviewed here.As a subsequent step, we plan to run commitlint in CI.
During the leveraging phase, we’ll utilize Conventional Commits to further automate the release process.