docs: add comprehensive examples page #303
Conversation
WalkthroughREADME was condensed to focus on installation and externalized usage/examples to Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)
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. Comment |
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive usage documentation to the commit-check project by creating a new example.rst file and reorganizing the README structure. The documentation focuses on providing practical examples for different usage scenarios.
Key changes include:
- Creation of detailed usage examples documentation covering pre-commit hooks, CLI usage, and various validation scenarios
- Addition of the new example.rst file to the documentation index
- Streamlining of the README by moving detailed usage examples to the dedicated documentation file
- Addition of "redesign" to the list of valid imperative verbs
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/index.rst | Added reference to new example.rst in the documentation table of contents |
| docs/example.rst | New comprehensive usage examples documentation with pre-commit, CLI, and validation scenarios |
| docs/changelog.rst | Removed status metadata from changelog header |
| commit_check/imperatives.py | Added "redesign" as a valid imperative verb |
| README.rst | Streamlined by moving detailed usage examples to dedicated documentation and reorganizing sections |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #303 +/- ##
=======================================
Coverage 86.98% 86.98%
=======================================
Files 8 8
Lines 684 684
=======================================
Hits 595 595
Misses 89 89 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
CodSpeed Performance ReportMerging #303 will not alter performanceComparing Summary
Footnotes
|
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
README.rst(2 hunks)commit_check/imperatives.py(1 hunks)docs/changelog.rst(0 hunks)docs/example.rst(1 hunks)docs/index.rst(1 hunks)
💤 Files with no reviewable changes (1)
- docs/changelog.rst
🧰 Additional context used
📓 Path-based instructions (1)
docs/**
📄 CodeRabbit inference engine (.github/copilot-instructions.md)
Maintain Sphinx documentation under docs/ to build HTML docs with sphinx-build
Files:
docs/index.rstdocs/example.rst
🧠 Learnings (3)
📚 Learning: 2025-10-03T10:28:06.793Z
Learnt from: CR
PR: commit-check/commit-check#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-10-03T10:28:06.793Z
Learning: Applies to .commit-check.yml : Maintain default validation rules for the tool in .commit-check.yml
Applied to files:
docs/example.rst
📚 Learning: 2025-10-03T10:28:06.793Z
Learnt from: CR
PR: commit-check/commit-check#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-10-03T10:28:06.793Z
Learning: Applies to commit_check/main.py : Expose CLI flags: --message, --branch, --help, --version, --config, --dry-run; support combining checks
Applied to files:
docs/example.rst
📚 Learning: 2025-10-03T10:28:06.793Z
Learnt from: CR
PR: commit-check/commit-check#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-10-03T10:28:06.793Z
Learning: Applies to commit_check/commit.py : Enforce Conventional Commits format: type(scope): description
Applied to files:
README.rst
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)
- GitHub Check: install (3.13, macos-latest)
- GitHub Check: install (3.10, windows-latest)
- GitHub Check: install (3.13, windows-latest)
- GitHub Check: install (3.14, macos-latest)
- GitHub Check: install (3.12, windows-latest)
- GitHub Check: install (3.14, windows-latest)
- GitHub Check: install (3.9, windows-latest)
- GitHub Check: install (3.10, macos-latest)
- GitHub Check: install (3.9, macos-latest)
- GitHub Check: install (3.11, windows-latest)
- GitHub Check: Run benchmarks
🔇 Additional comments (11)
commit_check/imperatives.py (1)
167-167: LGTM! Addition aligns with documentation.The imperative "redesign" is correctly added in alphabetical order and is referenced in the new documentation at line 200 of docs/example.rst.
docs/example.rst (5)
1-7: LGTM! Clear introduction.The title and introductory text effectively set expectations for the document's scope.
8-50: LGTM! Well-structured setup instructions.The GitHub Action and pre-commit hook sections provide clear, actionable steps with appropriate code blocks and tips.
52-224: LGTM! Comprehensive examples with clear organization.The pre-commit validation, CLI examples, and message validation sections provide thorough coverage with both valid and invalid examples.
226-315: LGTM! Detailed error output examples.The error output examples effectively demonstrate various failure scenarios with full ASCII art, helping users understand validation feedback.
317-354: LGTM! Practical integration guidance.The CI/CD and scripting examples provide useful patterns for real-world usage.
docs/index.rst (1)
9-9: LGTM! Proper toctree integration.The new "example" entry is correctly positioned in the documentation hierarchy between configuration and migration sections.
README.rst (4)
51-68: LGTM! Clear installation instructions.The installation section provides straightforward pip-based installation options with appropriate follow-up guidance.
70-84: LGTM! Simplified configuration overview.The configuration section effectively summarizes default and custom options while linking to detailed documentation.
85-88: LGTM! Appropriate delegation to detailed docs.The usage section correctly directs users to the comprehensive example documentation.
138-138: LGTM! Consistent documentation linking.The reference to example documentation maintains consistency with the new documentation structure.
8cb0650 to
1cd8c3c
Compare
|
closes #240
Summary by CodeRabbit
New Features
Documentation