docs: add commit body convention to project rule files#74
Conversation
- Subject-only commits made multi-file changes hard to trace; bodies must now explain the why, not restate the diff - Body is required for feat/refactor commits, or any commit touching 3+ files - AGENTS.md gets a one-line pointer so non-Claude agents follow the same rule Co-Authored-By: Claude Opus 4.7 <[email protected]>
Co-Authored-By: Claude Opus 4.7 <[email protected]>
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
There was a problem hiding this comment.
Review Complete ✅
This documentation update successfully extends the commit convention guidance across project rule files. All changes are consistent, well-structured, and maintain proper cross-references.
Changes Verified:
- ✅ Commit body format documented with clear template (subject + body bullets)
- ✅ Body-required rule consistently applied (feat/refactor or ≥3 files)
- ✅ One-logical-change-per-commit rule added
- ✅ Cross-reference from pr-flow.md to CLAUDE.md#commit-convention works correctly
No blocking issues found. The documentation improvements are ready to merge.
You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.
There was a problem hiding this comment.
Code Review
This pull request updates the commit convention guidelines across several documentation files, including .claude/commands/pr-flow.md, AGENTS.md, and CLAUDE.md. It mandates that commits represent a single logical change and details when a commit body (explaining the "why") is required—specifically for feat and refactor types, or any diff touching three or more files. Feedback on the changes suggests clarifying that small commits of other types (such as test, style, perf, and ci) can also be subject-only to eliminate ambiguity.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
Co-Authored-By: Claude Opus 4.7 <[email protected]>
- The type/file-count threshold kept producing technically compliant but opaque subject-only commits; user chose to drop the threshold entirely - pr-flow examples updated to multi -m form so the template itself cannot produce a subject-only commit Co-Authored-By: Claude Opus 4.7 <[email protected]>
Summary
feat/refactorcommits, or any diff touching ≥ 3 files; smallfix/docs/chorecommits may stay subject-only.claude/commands/pr-flow.mdStep 1 to reference the convention (cross-reference consistency)Changed Files
CLAUDE.mdAGENTS.md.claude/commands/pr-flow.mdTest Plan
code-reviewskill (low) on the branch diff: no findingsCLAUDE.md#commit-conventionresolves to the### Commit Conventionheading🤖 Generated with Claude Code