Skip to content

docs: update hook ID to 'check-message' in configuration examples#362

Merged
shenxianpeng merged 1 commit intomainfrom
fix/update-docs
Feb 2, 2026
Merged

docs: update hook ID to 'check-message' in configuration examples#362
shenxianpeng merged 1 commit intomainfrom
fix/update-docs

Conversation

@shenxianpeng
Copy link
Contributor

@shenxianpeng shenxianpeng commented Feb 2, 2026

Address #357 (comment)

Summary by CodeRabbit

  • Documentation
    • Updated pre-commit hook configuration documentation to reflect the latest hook identifier naming conventions in configuration examples and setup guides.

@shenxianpeng shenxianpeng requested a review from a team as a code owner February 2, 2026 17:36
@netlify
Copy link

netlify bot commented Feb 2, 2026

Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit 46f38a2
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/6980e0abd761620008069cb4
😎 Deploy Preview https://deploy-preview-362--commit-check.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions bot added bug Something isn't working documentation Improvements or additions to documentation labels Feb 2, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 2, 2026

📝 Walkthrough

Walkthrough

Documentation updated to reflect a different pre-commit hook ID identifier: changed from commit-check to check-message in README and configuration examples, with all other hook configuration remaining unchanged.

Changes

Cohort / File(s) Summary
Documentation Updates
README.rst, docs/configuration.rst
Pre-commit hook ID updated from commit-check to check-message in both documentation files. Hook arguments and configuration structure remain identical.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

documentation

Poem

🐰 A hook by any other name
Still checks the message just the same,
From commit-check to check-message we go,
Docs now reflect what users should know! 📝✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating the hook ID from 'commit-check' to 'check-message' in configuration examples across documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/update-docs

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

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

@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 2, 2026

@shenxianpeng shenxianpeng removed the bug Something isn't working label Feb 2, 2026
@shenxianpeng shenxianpeng changed the title fix: update hook ID to 'check-message' in configuration examples docs: update hook ID to 'check-message' in configuration examples Feb 2, 2026
@shenxianpeng shenxianpeng merged commit ecd99cb into main Feb 2, 2026
11 of 12 checks passed
@shenxianpeng shenxianpeng deleted the fix/update-docs branch February 2, 2026 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant