-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathCLAUDE.md.template
More file actions
65 lines (45 loc) · 1.64 KB
/
CLAUDE.md.template
File metadata and controls
65 lines (45 loc) · 1.64 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
64
65
# Project Instructions
> Customize this for your project. Keep it short - Claude reads this every session.
## Tech Stack
- **Frontend:** [React/Vue/etc.]
- **Backend:** [Node/Python/etc.]
- **Database:** [PostgreSQL/etc.]
- **Key libraries:** [list important ones]
## Project Structure
```
src/
├── components/ # React components
├── hooks/ # Custom hooks
├── utils/ # Helper functions
└── api/ # API client
```
## Commands
```bash
npm run dev # Start dev server
npm test # Run tests
npm run build # Production build
```
## Project Rules
<!-- Add rules specific to YOUR project -->
- Use `Button` from `@/components/ui`, not raw `<button>`
- API responses are camelCase (transformed from snake_case)
- State management: Zustand (not Redux)
- Styling: Tailwind only, no inline styles
## Patterns to Follow
<!-- Show examples from YOUR codebase -->
```typescript
// How we fetch data in this project
const { data, error } = useSWR('/api/users', fetcher);
// How we handle forms
const form = useForm<FormData>({ resolver: zodResolver(schema) });
```
## Don't Do
<!-- Project-specific things to avoid -->
- Don't create new API routes without adding to `api/index.ts`
- Don't use `localStorage` directly - use our `useStorage` hook
- Don't add dependencies without checking with the team
## Quality Checks
This project uses [vibe-and-thrive](https://github.com/allthriveai/vibe-and-thrive):
- **While coding:** Claude Code hooks warn about issues in real-time
- **At commit:** Pre-commit hooks block secrets, debug statements, etc.
- **On demand:** Run `/vibe-check` or `/review` anytime