Skip to content

docs: require Conventional Commits in CLAUDE.md#903

Merged
dangrondahl merged 1 commit into
mainfrom
update_claude_to_follow_conv_commits
May 21, 2026
Merged

docs: require Conventional Commits in CLAUDE.md#903
dangrondahl merged 1 commit into
mainfrom
update_claude_to_follow_conv_commits

Conversation

@dangrondahl
Copy link
Copy Markdown
Contributor

Summary

  • Add a top-level Commit Messages section to CLAUDE.md stating that all commits follow the Conventional Commits specification.
  • Drop the green: <what the test proves> example from the TDD loop's commit step so it no longer conflicts with the new convention.

Test plan

  • CLAUDE.md renders correctly and the TDD list stays sequential (1-7).

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 21, 2026

Claude finished @dangrondahl's task in 2m 5s —— View job


Review of PR #903

  • Gather context and read changed files
  • Run static analysis checks
  • Review changes
  • Post review feedback

Static Analysis

All clean — go build ./... and go vet ./... pass. No Go code changes, so no functional risk.

Review Summary

Clean, well-scoped docs PR. The commit message itself (docs: require Conventional Commits in CLAUDE.md) follows the convention it introduces — nice.

What's good:

  • Minimal change with clear intent
  • Correct placement — right after Workflow Preferences, before the heavier sections
  • Removing the green: example avoids a direct conflict with Conventional Commits

Two optional suggestions (posted as inline comments):

  1. Line 12 — The Commit Messages section is quite terse for an AI-guidance file. Adding a brief example of the types/scopes used in this repo (e.g. feat:, fix:, docs:) would help Claude produce better messages without needing to fetch the spec each time.

  2. Line 110 — TDD step 6 now says "commit the green state" with no format guidance. A small cross-reference to the new Commit Messages section would tie things together.

Neither is a blocker — the PR works as-is. LGTM with the optional nits.

Comment thread CLAUDE.md
Comment thread CLAUDE.md
@dangrondahl dangrondahl merged commit 9bca152 into main May 21, 2026
20 checks passed
@dangrondahl dangrondahl deleted the update_claude_to_follow_conv_commits branch May 21, 2026 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants