-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathCLAUDE.md.template
More file actions
63 lines (44 loc) · 1.67 KB
/
CLAUDE.md.template
File metadata and controls
63 lines (44 loc) · 1.67 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# Project: [PROJECT NAME]
## Overview
[Brief description in 1-2 sentences]
## Tech Stack
- **Language**: [e.g. TypeScript, Ruby, Go]
- **Framework**: [e.g. Next.js, Rails, Gin]
- **Database**: [e.g. PostgreSQL, SQLite]
- **Testing**: [e.g. Jest, RSpec, Go test]
- **Deploy**: [e.g. Kamal, Vercel, Fly.io]
## Architecture
[High-level project structure]
```
src/
├── [module A]/ # [responsibility]
├── [module B]/ # [responsibility]
└── [module C]/ # [responsibility]
```
## Coding Conventions
- Use [snake_case | camelCase] for variables and functions
- Use [PascalCase] for types/classes/components
- Prefer [composition over inheritance | pure functions | etc.]
- Import order: stdlib > external > internal
- Max [X] lines per function, [Y] lines per file
## Testing Rules
- All new code MUST have tests
- Test framework: [jest | rspec | pytest | etc.]
- Naming: `describe("[Module]") > it("should [behavior]")`
- Mocks only for external I/O (APIs, DB, filesystem)
- Run `[test command]` before considering a task complete
## Git Conventions
- Commits in English, format: `type(scope): description`
- Types: feat, fix, refactor, test, docs, chore
- Branches: `feat/name`, `fix/name`, `refactor/name`
- Never commit secrets, .env, or credentials
## Current Focus
[What is being developed now — update as the project evolves]
## Known Issues
[Known problems the agent should keep in mind]
## Do NOT
- Do not create documentation files unless asked
- Do not add dependencies without confirming first
- Do not change architecture without prior discussion
- Do not ignore failing tests
- Do not over-engineer — solve the current problem, not hypothetical ones