docs: update README.rst for v2 - #288
Conversation
Sorry, something went wrong.
WalkthroughUpdate README to reference TOML-based configuration (cchk.toml / commit-check.toml), remove certain CLI flags and pre-commit hook IDs, revise error/message examples and links, and increase subject_max_length in cchk.toml from 50 to 80 (and require Signed-off-by). Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Dev as Developer
participant Git as Git
participant Hook as pre-commit hook
participant CC as commit-check
participant Cfg as cchk.toml
Dev->>Git: git commit
Git->>Hook: Run configured hook
Hook->>CC: Invoke commit-check (uses TOML config)
CC->>Cfg: Load `cchk.toml` / `commit-check.toml`
Cfg-->>CC: subject_max_length=80, require_signed_off_by=true
CC->>CC: Validate commit (subject length, Signed-off-by, other checks)
alt Validation fails
CC-->>Hook: Reject (Commit rejected.)
else Validation passes
CC-->>Hook: Accept
end
Hook-->>Git: Result
Git-->>Dev: Commit accepted/rejected
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
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. ❤️ ShareComment @coderabbitai help to get the list of available commands and usage tips. |
Sorry, something went wrong.
|
Sorry, something went wrong.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review detailsConfiguration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📥 CommitsReviewing files that changed from the base of the PR and between a4e086d and dcf8ffb.
📒 Files selected for processing (1)- docs/configuration.rst (5 hunks)
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Maintain Sphinx documentation under docs/ to build HTML docs with sphinx-build
Files:
- docs/configuration.rst
Learnt from: CR PR: commit-check/commit-check#0 File: .github/copilot-instructions.md:0-0 Timestamp: 2025-10-03T10:28:06.753Z Learning: Applies to pyproject.toml : Declare package metadata, dependencies, and console entry points for commit-check and cchk
Applied to files:
- docs/configuration.rst
Sorry, something went wrong.
| - allow_authors | ||
| - list[str] | ||
| - [] (all allowed) | ||
| - List of allowed authors. If empty, all authors are allowed except those in ignore_authors. | ||
| * - commit | ||
| - ignore_authors | ||
| - list[str] | ||
| - [] (none ignored) | ||
| - List of authors to ignore (i.e., always allow). |
There was a problem hiding this comment.
⚠️ Potential issue | 🟠 Major
Clarify the allow_authors / ignore_authors defaults
The new description is self‑contradictory: it says that an empty allow_authors means “all authors are allowed except those in ignore_authors,” while the very next row explains that ignore_authors members are “always allow[ed].” Please reconcile these statements so readers know whether authors listed in ignore_authors are permitted or blocked when allow_authors is empty. A consistent explanation (and matching example comment above) is needed to avoid misconfiguration.
🤖 Prompt for AI AgentsIn docs/configuration.rst around lines 120 to 128, the two rows for allow_authors and ignore_authors are self-contradictory; decide and document a single consistent behavior and update both rows and the example accordingly—specifically, make ignore_authors explicitly "List of authors to always allow (exempt from allow_authors restrictions)" and change the allow_authors row to "[] (all allowed) — If empty, all authors are allowed; authors listed in ignore_authors are still permitted." Ensure the example comment above matches this wording.
Sorry, something went wrong.
Summary by CodeRabbit
Documentation
Chores