Skip to content

Commit 69eb260

Browse files
committed
docs: note hyphenated verb-prefix escape in imperative section
PR #115 added a third escape clause to check_imperative; section already enumerates the POS-tagger and WordNet-morphy strategies, so list this one alongside them for parity. Signed-off-by: Nerijus Bendžiūnas <nerijus.bendziunas@gmail.com>
1 parent 12a888a commit 69eb260

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -482,11 +482,14 @@ To selectively enable or disable checks, pass `args`:
482482

483483
## Imperative mood detection
484484

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

487487
1. nltk POS tagging — flags words tagged as past tense (`VBD`),
488488
gerund (`VBG`), third person (`VBZ`), etc.
489489
2. WordNet morphology as a fallback for words the tagger misclassifies.
490+
3. Hyphenated verb prefixes — accepts `re-enable`, `auto-detect`,
491+
`pre-process`, `co-locate`, `under-mine` and similar
492+
`<prefix>-<verb>` compounds the POS tagger misclassifies.
490493

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

0 commit comments

Comments
 (0)