Skip to content

Commit 49bb255

Browse files
hakanensariclaude
andcommitted
docs: add co-authoring and writing style guidelines
Add instructions for including co-authorship in commits when working with Claude. Add writing style guidance to avoid using hyphens and em dashes for connecting sentences. Co-authored-by: Claude <claude@anthropic.com>
1 parent 14944d5 commit 49bb255

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,12 @@ order = Order.parse(api_response_data)
128128
- Organize code into clear modules and classes. Avoid monolithic files
129129
- Wrap code and comments at 120 characters
130130

131+
### Writing Style
132+
133+
- **Avoid hyphens and em dashes to connect sentences.** Use periods instead for clearer, more direct prose
134+
- Keep documentation concise and to the point
135+
- Use active voice when possible
136+
131137
### Testing
132138

133139
- **Use Test-Driven Development (TDD):**
@@ -149,5 +155,7 @@ order = Order.parse(api_response_data)
149155
- Subject line: max 50 characters, imperative mood
150156
- Blank line between subject and body
151157
- Body: wrap at 72 characters, explain what and why (not how)
158+
- **ALWAYS add co-authorship** when working with Claude:
159+
- Add `Co-authored-by: Claude <claude@anthropic.com>` to commit messages
152160
- **NEVER use `git add .`** - always stage files explicitly by name
153161
- **ALWAYS update CHANGELOG.md when bumping versions** - document breaking changes, new features, and fixes

0 commit comments

Comments
 (0)