Skip to content

docs: add "Why commit-guard?" section to README #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benner merged 1 commit into from
May 5, 2026
Merged

docs: add "Why commit-guard?" section to README #98

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,16 @@

Opinionated conventional commit message linter with imperative mood detection.

Unlike regular expression only tools, commit-guard uses
NLP (nltk POS tagging) to verify that commit descriptions start with an
imperative verb.
## Why commit-guard?

* **NLP imperative detection.** Descriptions must start with an imperative
verb, verified via nltk POS tagging — not a hand-coded regex of "bad"
words.
* **Signature verification without a local keyring.** Resolves the commit
author via the GitHub API and verifies GPG/SSH against their published
`.gpg`/`.keys` — no per-runner key management.
* **Strict by default.** Subject format, body, trailers, `Signed-off-by`,
and signature all enforced out of the box; opt out with `--disable`.

## Example

Expand Down
Loading