Add lenient commit message linter with commitlint #48
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.
Add lenient commit message linter with
commitlint
This PR introduces a lightweight and opinionated
commitlint
setup. The goal is to gently encourage more descriptive and meaningful commit messages, without enforcing strict Conventional Commits or requiring type prefixes likefeat:
orfix:
.🧠 Why?
Commit messages are an essential part of project history. By enforcing a few light rules, we can:
git log
, GitHub, and Git clientswip
,qa
, orfix
that lack contextThis linter is here to help, not get in the way.
🔧 What it enforces
subject
is requiredTip
If 100 characters isn’t enough to describe your change, keep the subject short and clear, then use the commit body to provide additional context/information.
🛠️ How it works
git commit
, acommit-msg
hook triggerscommitlint
on the last commit messageThis is powered by
simple-git-hooks
, which runscommitlint
automatically at commit time.Example