Readme

[thumbrise]

Summary by CodeRabbit

• Documentation
  • Added complete project documentation featuring badges, table of contents, and detailed quick start guide with installation and usage instructions.
  • Included configuration file examples, pattern mapping explanations, CI integration notes, and schema reference links.
  • Enhanced configuration template with improved explanatory comments for clarity.

[coderabbitai]

Warning

Review limit reached

@thumbrise, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 54 minutes and 17 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 023a7ac0-35e8-48e3-baa1-e8396dabc94b

📥 Commits

Reviewing files that changed from the base of the PR and between 47d1972 and 6061ec4.

📒 Files selected for processing (1)

• README.md

📝 Walkthrough

Walkthrough

README documentation for commitlint-scope is added with badges, table of contents, quick start instructions, configuration examples, and schema references. The init command's embedded configuration template is enhanced with a comment clarifying the patterns section format.

Changes

Documentation and Configuration Guide

Layer / File(s)	Summary
README documentation and user guide README.md	README is populated with project description, navigation, usage instructions including install and run examples, configuration workflow with sample YAML, pattern mapping documentation, zero-configuration explanation, CI notes, schema reference, and license.
Configuration template patterns clarification cmd/commands/init.go	The InitConfigData embedded YAML template is enhanced with a comment explaining that the patterns section maps scope names to lists of glob patterns.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• thumbrise/commitlint-scope#10: Modifies the same InitConfigData YAML template in cmd/commands/init.go, indicating related work on configuration template documentation.

Poem

🐰 A README blooms, patterns now clear,
The init command's voice for all to hear,
With glob-shaped maps and examples bright,
New users find their way with delight! 📝✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Readme' is vague and generic, using a non-descriptive term that doesn't convey meaningful information about the changeset.	Use a more descriptive title that explains the main change, such as 'Add comprehensive README documentation' or 'Add README and improve config template documentation'.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch readme

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 73: Fix the grammatical error in the README sentence "Without
configuration file - scopes are gets as file-glob matches, relative to
repository root." by rewording it to a correct, concise form such as "Without a
configuration file, scopes are obtained as file-glob matches relative to the
repository root." Update the README.md entry containing that exact sentence.
- Line 23: The TOC entry uses the wrong anchor `#ci-usage`; update the README
TOC or header so they match: either change the TOC item `* [CI
usage](`#ci-usage`)` to `* [CI](`#ci`)` or rename the section header `## CI` to `##
CI usage` so the anchor becomes `#ci-usage`; ensure the TOC link text and anchor
correspond to the header (references: the TOC line `* [CI usage](`#ci-usage`)` and
the section header `## CI`).
- Around line 30-31: The README has grammatical errors and a typo: replace
"CODEOWNER" with "CODEOWNERS" and update the sentence "Useful if you dev-flow
require strict scoped file changes control over CI process." to a grammatically
correct form such as "Useful if your dev-flow requires strict scoped file change
control over the CI process" (or "Useful if your development flow requires
strict scoped file change control in the CI process"); edit the lines in the
README where the current text appears to apply these replacements.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: c27f26c6-e33f-419c-b768-ead9fc9a89f7

📥 Commits

Reviewing files that changed from the base of the PR and between 8165f35 and 47d1972.

📒 Files selected for processing (2)

• README.md
• cmd/commands/init.go

[github-actions]

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

• GitHub release
• v2.0.0

Your semantic-release bot 📦🚀