docs: update README.rst #239
Conversation
WalkthroughThe README documentation was updated to use clearer and more active language in the sections describing default and custom configuration usage. The explanations now explicitly state the behavior regarding configuration files and clarify the conventions enforced. No functional or instructional changes were made. 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 (
|
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.rst (2)
47-47: Consistent terminology?Everywhere else the doc uses “Conventional Commits” (plural) but “Conventional Branch” (singular).
Double-check that this is intentional; the spec itself is “Conventional Branches”.
If you want strict consistency, consider pluralising for clarity.
52-52: Minor RST & style polish for the custom-config sentenceA small tweak improves readability and avoids mixing back-ticks with the inline link text.
-To customize the behavior, create a config file ``.commit-check.yml`` under your repository's root directory, e.g., `.commit-check.yml <https://github.com/commit-check/commit-check/blob/main/.commit-check.yml>`_ +To customize the behavior, add a ``.commit-check.yml`` file to the root of your repository. +For a reference implementation, see the `sample configuration <https://github.com/commit-check/commit-check/blob/main/.commit-check.yml>`__.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.rst(1 hunks)
🔇 Additional comments (1)
README.rst (1)
45-45: Clear and concise—nice improvement.The sentence now directly states what happens when no configuration is provided.
No further issues spotted here.
Summary by CodeRabbit