Skip to content

docs: update README.md #16

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 3 commits into from
Mar 22, 2026
Merged

docs: update README.md #16

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
61be389
docs: fix line length in example output
benner Mar 22, 2026
3959b1e
docs: correct imperative mood detection description
benner Mar 22, 2026
f9251a6
docs: document post-commit signature hook
benner Mar 22, 2026
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
17 changes: 11 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ imperative verb.

```bash
$ commit-guard
✗ subject does not match 'type(scope): description': Merge pull request #5 from fix/branch
✗ subject does not match 'type(scope): description':
Merge pull request #5 from fix/branch
✗ missing 'Signed-off-by' trailer
✗ commit is not signed (GPG/SSH)
```
Expand Down Expand Up @@ -104,14 +105,19 @@ repos:
rev: v0.1.0
hooks:
- id: commit-guard
- id: commit-guard-signature
```

Install the hook:
Install the hooks:

```bash
pre-commit install --hook-type commit-msg
pre-commit install --hook-type commit-msg --hook-type post-commit
```

`commit-guard` runs at the `commit-msg` stage and checks message format.
`commit-guard-signature` runs at the `post-commit` stage and verifies
the GPG/SSH signature after the commit object is created.

To selectively enable or disable checks, pass `args`:

```yaml
Expand All @@ -123,10 +129,9 @@ To selectively enable or disable checks, pass `args`:

commit-guard combines two strategies to detect non-imperative descriptions:

1. A whitelist common commit verbs (`add`, `fix`, `remove`, etc.)
that pass immediately without NLP.
2. nltk POS tagging as a fallback — flags words tagged as past tense (`VBD`),
1. nltk POS tagging — flags words tagged as past tense (`VBD`),
gerund (`VBG`), third person (`VBZ`), etc.
2. WordNet morphology as a fallback for words the tagger misclassifies.

This catches common mistakes like `added logging` or `fixes bug` while
keeping false positives low.
Expand Down