Skip to content

docs: note hyphenated verb-prefix escape in imperative section #116

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 17, 2026
Merged

docs: note hyphenated verb-prefix escape in imperative section #116

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
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,11 +482,14 @@ To selectively enable or disable checks, pass `args`:

## Imperative mood detection

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

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.
3. Hyphenated verb prefixes — accepts `re-enable`, `auto-detect`,
`pre-process`, `co-locate`, `under-mine` and similar
`<prefix>-<verb>` compounds the POS tagger misclassifies.

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