-
Notifications
You must be signed in to change notification settings - Fork 41
docs: add Claude formatting instructions #1218
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -130,3 +130,49 @@ Each component directory contains a `summary.md` file documenting: | |
| - `docs/handover/` - Comprehensive architecture documentation | ||
| - `ARCHITECTURE.md` - Migration guide for old vs new style | ||
| - Component-specific `summary.md` files throughout the codebase | ||
|
|
||
| ## Claude Development Guidelines | ||
|
|
||
| This section contains specific instructions for Claude when working on this | ||
| project. | ||
|
|
||
| ### Formatting Commands | ||
|
|
||
| After making any code modifications, run the appropriate formatting commands: | ||
|
|
||
| #### Markdown Files | ||
|
|
||
| - **Format**: Run `make format-md` after modifying any markdown files | ||
| - **Check**: Run `make check-md` to verify markdown files are formatted | ||
| correctly | ||
|
|
||
| #### Rust and TOML Files | ||
|
|
||
| - **Format**: Run `make format` after modifying any Rust (.rs) or TOML (.toml) | ||
| files | ||
| - **Check**: Run `make check-format` to verify Rust and TOML files are formatted | ||
| correctly | ||
|
|
||
| ### Commit Guidelines | ||
|
|
||
| **NEVER** add Claude as a co-author in commit messages. Do not include: | ||
|
|
||
| - `Co-Authored-By: Claude <[email protected]>` | ||
| - Any other co-author attribution for Claude | ||
|
|
||
| **NEVER** use emojis in commit messages. | ||
|
|
||
| **Always** wrap commit message titles at 80 characters and body text at 80 | ||
| characters. | ||
|
|
||
| Always verify commit messages before committing and remove any co-author lines | ||
| referencing Claude. | ||
|
|
||
| ### Development Workflow | ||
|
|
||
| 1. Make your code changes | ||
| 2. Run the appropriate formatting command based on file types modified | ||
| 3. Verify formatting with check commands if needed | ||
| 4. **Verify commit message does not include Claude as co-author** | ||
| 5. **Verify commit message contains no emojis and follows 80-character wrap** | ||
| 6. Proceed with testing or committing changes | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will evolve over time