Skip to content

Commit 1af77e6

Browse files
committed
docs: add Claude development guidelines to CLAUDE.md
Add formatting and commit guidelines for Claude: - make format-md for markdown files - make format for Rust/TOML files - make check-md and make check-format for verification - Never add Claude as co-author in commits - Never use emojis in commit messages - Always wrap commit messages at 80 characters
1 parent 43c7d5b commit 1af77e6

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

CLAUDE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,3 +130,39 @@ Each component directory contains a `summary.md` file documenting:
130130
- `docs/handover/` - Comprehensive architecture documentation
131131
- `ARCHITECTURE.md` - Migration guide for old vs new style
132132
- Component-specific `summary.md` files throughout the codebase
133+
134+
## Claude Development Guidelines
135+
136+
This section contains specific instructions for Claude when working on this project.
137+
138+
### Formatting Commands
139+
140+
After making any code modifications, run the appropriate formatting commands:
141+
142+
#### Markdown Files
143+
- **Format**: Run `make format-md` after modifying any markdown files
144+
- **Check**: Run `make check-md` to verify markdown files are formatted correctly
145+
146+
#### Rust and TOML Files
147+
- **Format**: Run `make format` after modifying any Rust (.rs) or TOML (.toml) files
148+
- **Check**: Run `make check-format` to verify Rust and TOML files are formatted correctly
149+
150+
### Commit Guidelines
151+
152+
**NEVER** add Claude as a co-author in commit messages. Do not include:
153+
- `Co-Authored-By: Claude <[email protected]>`
154+
- Any other co-author attribution for Claude
155+
156+
**NEVER** use emojis in commit messages.
157+
158+
**Always** wrap commit message titles at 80 characters and body text at 80 characters.
159+
160+
Always verify commit messages before committing and remove any co-author lines referencing Claude.
161+
162+
### Development Workflow
163+
1. Make your code changes
164+
2. Run the appropriate formatting command based on file types modified
165+
3. Verify formatting with check commands if needed
166+
4. **Verify commit message does not include Claude as co-author**
167+
5. **Verify commit message contains no emojis and follows 80-character wrap**
168+
6. Proceed with testing or committing changes

0 commit comments

Comments
 (0)