Skip to content

Commit 4432455

Browse files
committed
fix: relax CLAUDE.md rules and add code fence language
- Changed 200-line limit from hard rule to guidance - Added JSDoc policy section with approved files - Added large file exceptions with specific approved files - Added plaintext language to code fence - Removed overly restrictive 'no JSDoc' rule
1 parent f429aa1 commit 4432455

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

CLAUDE.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,22 @@
44

55
### General
66
- NO emojis anywhere - not in code, comments, docs, or commit messages
7-
- Files must stay under 200 lines. Split if larger.
8-
- Comments explain WHY, not WHAT. One-liners only.
9-
- No decorative headers, no JSDoc blocks, no ASCII art
7+
- Prefer files under 200 lines. Larger files allowed when logically cohesive.
8+
- Comments explain WHY, not WHAT. Keep them brief.
9+
- No decorative headers or ASCII art
1010
- Casual tone in comments - write like a human, not a robot
1111

12+
### JSDoc Policy
13+
- JSDoc allowed for public API functions and exported hooks
14+
- Keep JSDoc minimal - document params and return types, not obvious behavior
15+
- Approved files using JSDoc: `frontend/src/services/playground-api.ts`, `frontend/src/config/api.ts`, `frontend/src/hooks/useViewTransition.ts`
16+
17+
### Large File Exceptions
18+
These files exceed 200 lines but are approved due to logical cohesion:
19+
- `backend/routes/playground.py`
20+
- `backend/services/dna_extractor.py`
21+
- `frontend/src/components/DependencyGraph/index.tsx`
22+
1223
### Frontend (TypeScript/React)
1324
- Package manager: **Bun only**. Never npm, never yarn.
1425
- Always `bun install`, `bun run dev`, `bun run build`
@@ -33,7 +44,7 @@
3344
## Architecture
3445

3546
### Project Structure
36-
```
47+
```plaintext
3748
backend/ # FastAPI, Python 3.11+
3849
frontend/ # React 18, TypeScript, Vite, Bun
3950
mcp-server/ # MCP protocol server
@@ -54,6 +65,4 @@ mcp-server/ # MCP protocol server
5465
- Don't use npm (use Bun)
5566
- Don't add emojis
5667
- Don't write verbose comments
57-
- Don't create files over 200 lines
5868
- Don't add "AI-looking" badges or decorations
59-
- Don't use JSDoc or decorative comment blocks

0 commit comments

Comments
 (0)