Skip to content

Commit 6fce5c3

Browse files
authored
Merge pull request #1218 from o1-labs/add-claude-formatting-instructions
docs: add Claude formatting instructions
2 parents 43c7d5b + 1023f56 commit 6fce5c3

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

CLAUDE.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,3 +130,49 @@ 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
137+
project.
138+
139+
### Formatting Commands
140+
141+
After making any code modifications, run the appropriate formatting commands:
142+
143+
#### Markdown Files
144+
145+
- **Format**: Run `make format-md` after modifying any markdown files
146+
- **Check**: Run `make check-md` to verify markdown files are formatted
147+
correctly
148+
149+
#### Rust and TOML Files
150+
151+
- **Format**: Run `make format` after modifying any Rust (.rs) or TOML (.toml)
152+
files
153+
- **Check**: Run `make check-format` to verify Rust and TOML files are formatted
154+
correctly
155+
156+
### Commit Guidelines
157+
158+
**NEVER** add Claude as a co-author in commit messages. Do not include:
159+
160+
- `Co-Authored-By: Claude <[email protected]>`
161+
- Any other co-author attribution for Claude
162+
163+
**NEVER** use emojis in commit messages.
164+
165+
**Always** wrap commit message titles at 80 characters and body text at 80
166+
characters.
167+
168+
Always verify commit messages before committing and remove any co-author lines
169+
referencing Claude.
170+
171+
### Development Workflow
172+
173+
1. Make your code changes
174+
2. Run the appropriate formatting command based on file types modified
175+
3. Verify formatting with check commands if needed
176+
4. **Verify commit message does not include Claude as co-author**
177+
5. **Verify commit message contains no emojis and follows 80-character wrap**
178+
6. Proceed with testing or committing changes

0 commit comments

Comments
 (0)