docs: clarify comment style and commit bisectability guidance - #7490
Conversation
Discourage comments that merely restate code, favoring readable code itself. Relax atomic-commit rule to allow an intentionally non-building commit (e.g. a regression test preceding its fix) when called out explicitly. Also point the PR-title rule at the CI linter (semantic-pull-request.yml) that enforces valid types/scopes.
WalkthroughUpdated Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
|
✅ Final review complete — no blockers (commit d3ed9c7) |
fd065c9 to
d3ed9c7
Compare
There was a problem hiding this comment.
Final validation — Codex + Sonnet
This docs-only change keeps AGENTS.md and CLAUDE.md byte-identical, and the referenced semantic-pull-request workflow does enforce the documented Conventional Commit types and scopes. The proposed distinction between test-failing and non-building commits would reverse the explicitly stated policy relaxation rather than correct a factual error, so there are no actionable findings.
Source: reviewers gpt-5.6-sol (general, dash-core-commit-history) and claude-sonnet-5 (general, dash-core-commit-history); final verifier gpt-5.6-sol via the policy-permitted Claude Code fallback after the primary claude-sonnet-5 verifier returned fenced, unparseable JSON.
Review provenance
- Codex reviewers:
gpt-5.6-sol— general (completed),gpt-5.6-sol— dash-core-commit-history (completed) - Verifier:
gpt-5.6-sol— final-verifier (fallback) - Sonnet reviewers:
claude-sonnet-5— general (completed),claude-sonnet-5— dash-core-commit-history (completed)
Issue being fixed or feature being added
Agent guidance in
CLAUDE.md/AGENTS.mddidn't address comment verbosity, allow non-building commits (e.g. a regression test before its fix), or point at the CI check that validates PR titles.What was done
.github/workflows/semantic-pull-request.yml, which enforces the valid Conventional Commit types/scopes.CLAUDE.mdandAGENTS.mdin sync as required.How Has This Been Tested
Docs-only change; diffed the two files to confirm they still match.
Breaking Changes
None.
Checklist