This repository was archived by the owner on Dec 21, 2021. It is now read-only.
Add husky & commitlint to enforce conventional-commit messages #228
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 adds a commit message git hook that should "enforce" the
type(scope):format for commit messages.There are other rules but I've relaxed them a bunch and also set it not run during rebases.
If you find any of these rules annoying, please let me know and we can just disable it.
If there's a problem with the validation and you really need to skip this hook, you can always run your
gitcommands with the--no-verifyflag, e.g.Currently this is not validated in CI, local only.
Open to expanding the list of types or maybe enforcing list of scopes.
Possible this may cause issues with the gh-pages action, since it's writing commits to theupdate: Fixed by adding additional types.gh-pagesbranch.