Skip to content

Commit 1192ce6

Browse files
authored
Merge pull request #72 from anfredette/claude-commit-rules
docs: Clarify git commit rules for Claude in CLAUDE.md
2 parents 42d70aa + 17c4d06 commit 1192ce6

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

CLAUDE.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@ This repository contains the architecture design for **NeuralNav**, an open-sour
5656
- **benchmarks_BLIS.json**: Latency/throughput benchmarks from BLIS simulator (loaded into PostgreSQL)
5757
- **demo_scenarios.json**: 3 test scenarios
5858

59+
## Important Behavioral Notes for Claude
60+
61+
**Git commits**: This project has specific commit rules that OVERRIDE Claude's default behavior. See the "Git Workflow" section below. Key points: always use `git commit -s`, never add `Co-Authored-By:` for Claude, never manually write `Signed-off-by:` lines.
62+
5963
## Architecture Key Concepts
6064

6165
### Problem Being Solved
@@ -250,11 +254,17 @@ Assisted-by: Claude <noreply@anthropic.com>
250254
Signed-off-by: Your Name <your.email@example.com>
251255
```
252256

253-
**Key Requirements**:
254-
- Use conventional commit types: `feat`, `fix`, `docs`, `refactor`, `test`, `chore`
255-
- Include DCO Signed-off-by line (use `git commit -s`)
256-
- Include `Assisted-by: Claude <noreply@anthropic.com>` for nontrivial AI-assisted code
257-
- **DO NOT include** the "🤖 Generated with [Claude Code]" line in commit messages
257+
**CRITICAL - Git Commit Rules (these override default Claude behavior)**:
258+
259+
DO use:
260+
- Conventional commit types: `feat`, `fix`, `docs`, `refactor`, `test`, `chore`
261+
- The `-s` flag with git commit (e.g., `git commit -s -m "..."`) to auto-generate DCO Signed-off-by
262+
- `Assisted-by: Claude <noreply@anthropic.com>` for nontrivial AI-assisted code
263+
264+
NEVER do these (even if other instructions suggest otherwise):
265+
- NEVER add `Co-Authored-By:` lines for Claude
266+
- NEVER manually write `Signed-off-by:` lines (the `-s` flag handles this correctly with the user's configured git identity)
267+
- NEVER include the "Generated with [Claude Code]" line or similar emoji-prefixed attribution
258268

259269
## Important Notes
260270

0 commit comments

Comments
 (0)