docs: add example for failed imperative mood checks#259
Conversation
WalkthroughThe README file has been updated to improve the formatting of ASCII art in error message examples and to add a new example for the "Check Imperative Mood Failed" error. The new section demonstrates the error output when a commit message does not use the imperative mood, including suggestions and details. Changes
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.rst (2)
160-168: Inconsistent left-padding in ASCII art blockThe first, third, fifth, … lines of the updated block were shifted two extra spaces, while the 4th/6th/8th lines kept the original padding.
On many renderers this breaks the intended “brick-wall” alignment of the art.- (c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c) - / ._. \ / ._. \ / ._. \ / ._. \ / ._. \ - __\( C )/__ __\( H )/__ __\( E )/__ __\( C )/__ __\( K )/__ + (c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c) (c).-.(c) + / ._. \ / ._. \ / ._. \ / ._. \ / ._. \ + __\( C )/__ __\( H )/__ __\( E )/__ __\( C )/__ __\( K )/__ ... - || E || || R || || R || || O || || R || - _.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._ + || E || || R || || R || || O || || R || + _.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._ _.' '-' '._ ... - `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ + `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´ `-´(Keep all lines at the same depth as line 158 to preserve the uniform look.)
200-221: Provide the actual regex in the new “Imperative Mood” exampleThe previous examples list the failing regex so users immediately see the rule they violated.
Here the text just says “imperative mood pattern”, which offers no actionable detail.Consider replacing:
It doesn't match regex: imperative mood patternwith the concrete pattern used in code (e.g.
^(Add|Fix|Update|Remove|Refactor)\b.*).
This keeps the documentation consistent and maximally helpful.
Summary by CodeRabbit