awesome-claude-notes / examples

# Example Project CLAUDE.md

This is an example project-level CLAUDE.md file. Place this in your project root.

## Project Overview

[Brief description of your project - what it does, tech stack]

## Critical Rules

### 1. Code Organization

- Many small files over few large files
- High cohesion, low coupling
- 200-400 lines typical, 800 max per file
- Organize by feature/domain, not by type

### 2. Code Style

- No emojis in code, comments, or documentation
- Immutability always - never mutate objects or arrays
- No console.log in production code
- Proper error handling with try/catch
- Input validation with Zod or similar

### 3. Testing

- TDD: Write tests first
- 80% minimum coverage
- Unit tests for utilities
- Integration tests for APIs
- E2E tests for critical flows

### 4. Security

- No hardcoded secrets
- Environment variables for sensitive data
- Validate all user inputs
- Parameterized queries only
- CSRF protection enabled

## File Structure

```
src/
|-- app/              # Next.js app router
|-- components/       # Reusable UI components
|-- hooks/            # Custom React hooks
|-- lib/              # Utility libraries
|-- types/            # TypeScript definitions
```

## Key Patterns

### API Response Format

```typescript
interface ApiResponse<T> {
  success: boolean
  data?: T
  error?: string
}
```

### Error Handling

```typescript
try {
  const result = await operation()
  return { success: true, data: result }
} catch (error) {
  console.error('Operation failed:', error)
  return { success: false, error: 'User-friendly message' }
}
```

## Environment Variables

```bash
# Required
DATABASE_URL=
API_KEY=

# Optional
DEBUG=false
```

## Available Commands

- `/tdd` - Test-driven development workflow
- `/plan` - Create implementation plan
- `/code-review` - Review code quality
- `/build-fix` - Fix build errors

## Git Workflow

- Conventional commits: `feat:`, `fix:`, `refactor:`, `docs:`, `test:`
- Never commit to main directly
- PRs require review
- All tests must pass before merge

More agent context in loulanyue/awesome-claude-notes

178 other files this repository gives its agents, the first 60 shown.

Also found in 21 other repositories

The same file, byte for byte, in the weekly crawl of public GitHub; the 10 with the most stars.

• WorldFlowAI/everything-claude-code2k
• tpavanipradeep/everything-claude-code104
• mit-network/everything-claude-code76
• j7-dev/everything-github-copilot19
• Infopibe/everything-claude-code8
• XD3an/cc-plus4
• yapota2018/affaan-m-everything-claude-code4
• ArogyaReddy/https-github.com-affaan-m-everything-claude-code12
• steven715/cpp-claude-code2
• ashutoshrathi0909-oss/everything-claude-code1