fix: clean up pre-commit config and hook #297

shenxianpeng · 2025-10-10T23:00:35Z

Summary by CodeRabbit

Documentation
- Clarified and reworded Highlights and What’s New for readability, with improved emphasis and a refined call-to-action.
Chores
- Enabled branch name checks by default in commit tooling.
- Simplified optional hooks configuration to reduce noise.
- Removed explicit commit message stage binding for a hook to rely on default behavior.

coderabbitai · 2025-10-10T23:00:43Z

Walkthrough

Enables the check-branch hook in .pre-commit-config.yaml, removes explicit commit-msg stage and prunes commented hook entries. In .pre-commit-hooks.yaml, removes the stages: [commit-msg] from check-message. README.rst receives minor wording and emphasis updates in Highlights/What’s New. No code or runtime logic changes.

Changes

Cohort / File(s)	Summary of Changes
Pre-commit configuration `./.pre-commit-config.yaml`, `./.pre-commit-hooks.yaml`	Enabled `check-branch` hook; removed explicit `default_install_hook_types: [pre-commit, commit-msg]` and pruned commented optional hooks/notes. In hooks spec, deleted `stages: [commit-msg]` from `check-message`, leaving it unbound to commit-msg explicitly.
Documentation updates `./README.rst`	Reworded and bolded items in Highlights/What’s New; adjusted phrasing about visiting the page. Text-only edits; no functional impact.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

docs: add v2.0.0 documentation #289 — Also edits README.rst “What’s New / Highlights” wording for the same v2.0.0 notes.
docs: update README.rst for v2 #288 — Adjusts README.rst and hook listings, including removal of several hook IDs similar to this PR.

Suggested labels

enhancement

Poem

I twitch my whiskers at tidy hooks,
Branch names checked—no chance for crooks.
The message stage hops out of sight,
Docs get a polish, shiny and light.
Tap-tap goes my commit dance—
Pre-commit ready, onwards I prance! 🐇✨

Pre-merge checks and finishing touches

✅ 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 succinctly and accurately describes the primary change—cleaning up the pre-commit configuration and hook setup—using conventional commit style to indicate a fix, which aligns directly with the modifications outlined in the .pre-commit-config.yaml and .pre-commit-hooks.yaml updates.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch bugfix/patch-2

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 · 2025-10-10T23:00:59Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

codecov · 2025-10-10T23:01:52Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.33%. Comparing base (1e4db5d) to head (90417da).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #297   +/-   ##
=======================================
  Coverage   87.33%   87.33%           
=======================================
  Files           8        8           
  Lines         687      687           
=======================================
  Hits          600      600           
  Misses         87       87

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1e4db5d and 90417da.

📒 Files selected for processing (3)

.pre-commit-config.yaml (1 hunks)
.pre-commit-hooks.yaml (0 hunks)
README.rst (1 hunks)

💤 Files with no reviewable changes (1)

.pre-commit-hooks.yaml

🧰 Additional context used

📓 Path-based instructions (1)

.pre-commit-config.yaml

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Maintain pre-commit configuration to run repository hooks

Files:

.pre-commit-config.yaml

🧠 Learnings (2)

📓 Common learnings

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 .pre-commit-config.yaml : Maintain pre-commit configuration to run repository hooks

📚 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 .pre-commit-config.yaml : Maintain pre-commit configuration to run repository hooks

Applied to files:

.pre-commit-config.yaml

⏰ 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). (14)

GitHub Check: install (3.10, macos-latest)
GitHub Check: install (3.13, windows-latest)
GitHub Check: install (3.14, ubuntu-24.04)
GitHub Check: install (3.13, macos-latest)
GitHub Check: install (3.14, windows-latest)
GitHub Check: install (3.14, macos-latest)
GitHub Check: install (3.11, macos-latest)
GitHub Check: install (3.12, windows-latest)
GitHub Check: install (3.10, ubuntu-24.04)
GitHub Check: install (3.11, windows-latest)
GitHub Check: install (3.10, windows-latest)
GitHub Check: install (3.9, macos-latest)
GitHub Check: install (3.9, ubuntu-24.04)
GitHub Check: install (3.9, windows-latest)

coderabbitai · 2025-10-10T23:06:10Z

.pre-commit-config.yaml

    -   id: check-message
-    # -   id: check-branch          # uncomment if you need.
+    -   id: check-branch          # uncomment if you need.
    -   id: check-author-name     # uncomment if you need.
    -   id: check-author-email    # uncomment if you need.


⚠️ Potential issue | 🔴 Critical

Restore commit-msg installation for check-message.

Dropping default_install_hook_types: [pre-commit, commit-msg] (and the commit-msg stage) means pre-commit install no longer sets up the commit-msg hook, so check-message never runs. The commit message validator silently stops working—a regression. Please restore commit-msg installation (either via default_install_hook_types or per-hook stages: [commit-msg], plus the matching change in .pre-commit-hooks.yaml) so the check keeps executing.

repos: +- default_install_hook_types: [pre-commit, commit-msg] - repo: https://github.com/commit-check/commit-check rev: v0.10.2 hooks: - id: check-message + stages: [commit-msg]

Based on learnings

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents

.pre-commit-config.yaml lines 36-39: the commit-msg hook installation was removed so the check-message hook never runs; restore commit-msg installation by either adding back default_install_hook_types: [pre-commit, commit-msg] to the file or by adding stages: [commit-msg] to the check-message hook entry and also ensure the corresponding .pre-commit-hooks.yaml lists commit-msg in that hook's stages; update both files accordingly so pre-commit install sets up the commit-msg hook and the check-message hook executes on commit messages.

fix: clean up pre-commit config and hook

90417da

shenxianpeng added the bug Something isn't working label Oct 10, 2025

shenxianpeng requested a review from a team as a code owner October 10, 2025 23:00

github-actions bot added the documentation Improvements or additions to documentation label Oct 10, 2025

shenxianpeng merged commit 189c9d1 into main Oct 10, 2025
30 checks passed

shenxianpeng deleted the bugfix/patch-2 branch October 10, 2025 23:05

coderabbitai bot reviewed Oct 10, 2025

View reviewed changes

shenxianpeng removed the documentation Improvements or additions to documentation label Oct 10, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix: clean up pre-commit config and hook #297

fix: clean up pre-commit config and hook #297

Uh oh!

shenxianpeng commented Oct 10, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Oct 10, 2025 •

edited

Loading

Uh oh!

sonarqubecloud bot commented Oct 10, 2025

Uh oh!

codecov bot commented Oct 10, 2025 •

edited

Loading

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Oct 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

fix: clean up pre-commit config and hook #297

fix: clean up pre-commit config and hook #297

Uh oh!

Conversation

shenxianpeng commented Oct 10, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Poem

Pre-merge checks and finishing touches

Uh oh!

sonarqubecloud bot commented Oct 10, 2025

Quality Gate passed

Uh oh!

codecov bot commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

shenxianpeng commented Oct 10, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 10, 2025 •

edited

Loading

codecov bot commented Oct 10, 2025 •

edited

Loading