feat: allow docs, ci, test, refactor branches by default by sahilsaiyed-oss · Pull Request #505 · commit-check/commit-check

sahilsaiyed-oss · 2026-07-31T18:08:09Z

Summary

This PR updates the default branch types so they are consistent with the default Conventional Commit types.

Changes

Added build
Added ci
Added docs
Added perf
Added refactor
Added style
Added test

Summary by CodeRabbit

New Features
- Added support for additional conventional branch types: build, ci, docs, perf, refactor, style, and test.
- Branches using these prefixes are now accepted by default.
Documentation
- Updated configuration examples and reference tables to reflect the expanded default branch types.
Tests
- Added validation coverage for branches using the newly supported prefixes.

netlify · 2026-07-31T18:08:14Z

✅ Deploy Preview for commit-check ready!

Name	Link
🔨 Latest commit	`bf7c60d`
🔍 Latest deploy log	https://app.netlify.com/projects/commit-check/deploys/6a6e5a29a8136300080621e1
😎 Deploy Preview	https://deploy-preview-505--commit-check.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

coderabbitai · 2026-07-31T18:08:20Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f91a27bc-3b03-4ac7-9a17-936b8ee26644

📥 Commits

Reviewing files that changed from the base of the PR and between c93e730 and bf7c60d.

📒 Files selected for processing (4)

README.md
commit_check/__init__.py
docs/configuration.rst
tests/rule_builder_test.py

🚧 Files skipped from review as they are similar to previous changes (4)

README.md
commit_check/init.py
tests/rule_builder_test.py
docs/configuration.rst

📝 Walkthrough

Walkthrough

The default allowed branch types now include seven additional conventional prefixes. The README and configuration documentation show the expanded list. Tests verify the new defaults and valid branch names.

Changes

Default branch type expansion

Layer / File(s)	Summary
Expand default branch type set `commit_check/__init__.py`	`DEFAULT_BRANCH_TYPES` now includes `build`, `ci`, `docs`, `perf`, `refactor`, `style`, and `test`.
Update validation coverage and configuration examples `tests/rule_builder_test.py`, `README.md`, `docs/configuration.rst`	Tests cover the added prefixes and valid branch names. Documentation lists the expanded defaults.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related issues

Allow docs/, ci/, test/, refactor/ branches by default #494 — Directly tracks expanding the default branch types, documentation, and tests.

Possibly related PRs

commit-check/commit-check#504 — Makes the same changes to the same constant, documentation, and tests.
commit-check/commit-check#438 — Also expands DEFAULT_BRANCH_TYPES and validation tests.
commit-check/commit-check#442 — Also updates default branch prefixes with related tests and documentation.

Suggested labels: minor

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately identifies several branch types added by the pull request and reflects the main change.
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.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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.}

codecov · 2026-07-31T18:11:10Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.36%. Comparing base (102cc45) to head (bf7c60d).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #505   +/-   ##
=======================================
  Coverage   97.36%   97.36%           
=======================================
  Files          12       12           
  Lines        1175     1175           
=======================================
  Hits         1144     1144           
  Misses         31       31

☔ View full report in Codecov by Harness.
📢 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.

codspeed-hq · 2026-07-31T18:25:47Z

Merging this PR will regress 1 benchmark

⚠️

Different runtime environments detected

Some benchmarks with significant performance changes were compared across different runtime environments,
which may affect the accuracy of the results.

Open the report in CodSpeed to investigate

⚡ 1 improved benchmark
❌ 1 regressed benchmark
✅ 391 untouched benchmarks
⏩ 115 skipped benchmarks¹

Warning

Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

	Benchmark	`BASE`	`HEAD`	Efficiency
❌	`test_ai_agent_and_bot_branch_types_in_default`	196.7 µs	232.2 µs	-15.31%
⚡	`test_empty_message_passes`	1,171 µs	748 µs	+56.55%

Tip

Investigate this regression by commenting @codspeedbot fix this regression on this PR, or directly use the CodSpeed MCP with your agent.

_{Comparing sahilsaiyed-oss:feat/allow-default-branch-types (c93e730) with main (d534a3f)²}

115 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩
No successful run was found on main (102cc45) during the generation of this report, so d534a3f was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

coderabbitai

Actionable comments posted: 1

🤖 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 `@docs/configuration.rst`:
- Around line 436-437: Update the documented default branch-type list in the
configuration section to match DEFAULT_BRANCH_TYPES, adding ai, claude, codex,
copilot, cursor, dependabot, and renovate; keep the statement that these
prefixes are included by default accurate.

🪄 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: 7b79d873-3523-4050-9c77-0f06f5e86fd6

📥 Commits

Reviewing files that changed from the base of the PR and between 91c4a9f and c93e730.

📒 Files selected for processing (4)

README.md
commit_check/__init__.py
docs/configuration.rst
tests/rule_builder_test.py

coderabbitai · 2026-08-01T07:08:08Z

+     - ["feature", "bugfix", "hotfix", "release", "chore", "feat", "fix", "build", "ci", "docs", "perf", "refactor", "test", "style"]
     - Allowed branch types when conventional_branch is true. AI agent prefixes (``ai/``, ``claude/``, ``codex/``, ``copilot/``, ``cursor/``) and bot prefixes (``dependabot/``) are also included by default.


📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Synchronize the documented default with DEFAULT_BRANCH_TYPES.

commit_check/__init__.py also includes ai, claude, codex, copilot, cursor, dependabot, and renovate. The default list at Line 436 omits these values, although Line 437 says they are included by default. Add the missing prefixes or label this row as a partial example.

🤖 Prompt for 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. In `@docs/configuration.rst` around lines 436 - 437, Update the documented default branch-type list in the configuration section to match DEFAULT_BRANCH_TYPES, adding ai, claude, codex, copilot, cursor, dependabot, and renovate; keep the statement that these prefixes are included by default accurate.

shenxianpeng

Thanks for the PR!

sonarqubecloud · 2026-08-01T20:42:47Z

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

…509) Addresses the review comment on #505: the options table now lists the full default (all 21 types including AI agent and bot prefixes) and the docs explicitly note that DEFAULT_BRANCH_TYPES is a superset of the Conventional Branch spec, with strict spec-only validation available via an explicit allow_branch_types setting. Closes #494

sahilsaiyed-oss requested a review from a team as a code owner July 31, 2026 18:08

sahilsaiyed-oss requested review from shenxianpeng and removed request for a team July 31, 2026 18:08

github-actions Bot added documentation Improvements or additions to documentation enhancement New feature or request tests Add test related changes labels Jul 31, 2026

coderabbitai Bot reviewed Aug 1, 2026

View reviewed changes

shenxianpeng approved these changes Aug 1, 2026

View reviewed changes

sahilsaiyed-oss and others added 2 commits August 1, 2026 23:42

feat: allow docs, ci, test, refactor branches by default

7778215

Fix formatting in README.md for code block

bf7c60d

shenxianpeng force-pushed the feat/allow-default-branch-types branch from c93e730 to bf7c60d Compare August 1, 2026 20:42

shenxianpeng removed documentation Improvements or additions to documentation tests Add test related changes labels Aug 1, 2026

shenxianpeng merged commit 0ce5695 into commit-check:main Aug 1, 2026
29 checks passed

shenxianpeng mentioned this pull request Aug 1, 2026

docs: clarify allow_branch_types defaults are a superset of the spec #509

Merged

Navigation Menu

Uh oh!

Uh oh!

feat: allow docs, ci, test, refactor branches by default - #505

feat: allow docs, ci, test, refactor branches by default#505
shenxianpeng merged 2 commits into
commit-check:mainfrom
sahilsaiyed-oss:feat/allow-default-branch-types

sahilsaiyed-oss commented Jul 31, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

netlify Bot commented Jul 31, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jul 31, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

codecov Bot commented Jul 31, 2026 •

edited

Loading

Uh oh!

codspeed-hq Bot commented Jul 31, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot Aug 1, 2026

Uh oh!

shenxianpeng left a comment

Uh oh!

sonarqubecloud Bot commented Aug 1, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		- ["feature", "bugfix", "hotfix", "release", "chore", "feat", "fix", "build", "ci", "docs", "perf", "refactor", "test", "style"]
		- Allowed branch types when conventional_branch is true. AI agent prefixes (``ai/``, ``claude/``, ``codex/``, ``copilot/``, ``cursor/``) and bot prefixes (``dependabot/``) are also included by default.

Uh oh!

Uh oh!

Conversation

sahilsaiyed-oss commented Jul 31, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Summary by CodeRabbit

Uh oh!

netlify Bot commented Jul 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for commit-check ready!

Uh oh!

coderabbitai Bot commented Jul 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

codecov Bot commented Jul 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

codspeed-hq Bot commented Jul 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will regress 1 benchmark

Performance Changes

Footnotes

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Aug 1, 2026

Choose a reason for hiding this comment

Uh oh!

shenxianpeng left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Aug 1, 2026

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sahilsaiyed-oss commented Jul 31, 2026 •

edited by coderabbitai Bot

Loading

netlify Bot commented Jul 31, 2026 •

edited

Loading

coderabbitai Bot commented Jul 31, 2026 •

edited

Loading

codecov Bot commented Jul 31, 2026 •

edited

Loading

codspeed-hq Bot commented Jul 31, 2026 •

edited

Loading