docs: add example for failed imperative mood checks by shenxianpeng · Pull Request #259 · commit-check/commit-check · GitHub

Summary by CodeRabbit

Documentation
- Improved formatting of ASCII art in error message examples for better visual alignment.
- Added a new example error message for failed imperative mood checks in commit messages, including guidance on using imperative verbs.

Walkthrough

The 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

File	Change Summary
README.rst	Improved ASCII art alignment in error message examples; added a new "Check Imperative Mood Failed" example section with details and suggestions.

Poem

In README fields where errors bloom,
ASCII art now finds more room.
A new mood check joins the show,
"Use imperative!" it lets us know.
With tidy art and helpful cues,
Committers now have clearer views!
🐇✨

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.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.rst (2)
160-168: Inconsistent left-padding in ASCII art block

The 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” example

The 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 pattern
with the concrete pattern used in code (e.g. ^(Add|Fix|Update|Remove|Refactor)\b.*).
This keeps the documentation consistent and maximally helpful.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2b9711c and 4a6de6d.

📒 Files selected for processing (1)

README.rst (3 hunks)

docs: update README.md

4a6de6d

shenxianpeng added the documentation Improvements or additions to documentation label Jul 12, 2025

shenxianpeng marked this pull request as ready for review July 12, 2025 21:32

shenxianpeng requested a review from a team as a code owner July 12, 2025 21:32

coderabbitai Bot reviewed Jul 12, 2025

View reviewed changes

shenxianpeng changed the title docs: update README.md docs: add example for failed imperative mood checks Jul 12, 2025

shenxianpeng merged commit 952b91f into main Jul 12, 2025
8 checks passed

shenxianpeng deleted the chore/update-docs branch July 12, 2025 21:35

coderabbitai Bot mentioned this pull request Oct 3, 2025

docs: update README.rst for v2 #288

Merged

coderabbitai Bot mentioned this pull request Oct 12, 2025

docs: add comprehensive examples page #303

Merged

docs: add example for failed imperative mood checks by shenxianpeng · Pull Request #259 · commit-check/commit-check · GitHub

Uh oh!

Uh oh!

docs: add example for failed imperative mood checks - #259

docs: add example for failed imperative mood checks#259
shenxianpeng merged 1 commit into
mainfrom
chore/update-docs

shenxianpeng commented Jul 12, 2025 •
edited by coderabbitai Bot
Loading

Uh oh!

Uh oh!

coderabbitai Bot commented Jul 12, 2025 •
edited
Loading

Uh oh!

Uh oh!

sonarqubecloud Bot commented Jul 12, 2025

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

docs: add example for failed imperative mood checks by shenxianpeng · Pull Request #259 · commit-check/commit-check · GitHub

Uh oh!

Uh oh!

docs: add example for failed imperative mood checks - #259

docs: add example for failed imperative mood checks#259shenxianpeng merged 1 commit intomaincommit-check/commit-check:mainfrom chore/update-docscommit-check/commit-check:chore/update-docsCopy head branch name to clipboard

Conversation

shenxianpeng commented Jul 12, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jul 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

sonarqubecloud Bot commented Jul 12, 2025

Quality Gate passed

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

docs: add example for failed imperative mood checks#259
shenxianpeng merged 1 commit into
mainfrom
chore/update-docs

shenxianpeng commented Jul 12, 2025 •
edited by coderabbitai Bot
Loading

coderabbitai Bot commented Jul 12, 2025 •
edited
Loading