From 1af77e6558b369addb1377305100b8f5862e8919 Mon Sep 17 00:00:00 2001 From: Danny Willems Date: Mon, 21 Jul 2025 13:26:27 +0200 Subject: [PATCH 1/2] 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 --- CLAUDE.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/CLAUDE.md b/CLAUDE.md index 3dea9b10d7..dab5722b36 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -130,3 +130,39 @@ 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 ` +- 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 From 1023f56843c4514c3183c0c2e984aa4d5f08015f Mon Sep 17 00:00:00 2001 From: Danny Willems Date: Mon, 21 Jul 2025 13:29:10 +0200 Subject: [PATCH 2/2] format: apply prettier formatting to CLAUDE.md --- CLAUDE.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index dab5722b36..ca6bf64cfe 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -133,33 +133,43 @@ Each component directory contains a `summary.md` file documenting: ## Claude Development Guidelines -This section contains specific instructions for Claude when working on this project. +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 +- **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 + +- **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 ` - 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** 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. +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