mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-02-04 13:45:40 +08:00
45959c326e
Battle-tested configs from 10+ months of daily Claude Code usage. Won Anthropic x Forum Ventures hackathon building zenith.chat. Includes: - 9 specialized agents (planner, architect, tdd-guide, code-reviewer, etc.) - 9 slash commands (tdd, plan, e2e, code-review, etc.) - 8 rule files (security, coding-style, testing, git-workflow, etc.) - 7 skills (coding-standards, backend-patterns, frontend-patterns, etc.) - Hooks configuration (PreToolUse, PostToolUse, Stop) - MCP server configurations (15 servers) - Plugin/marketplace documentation - Example configs (project CLAUDE.md, user CLAUDE.md, statusline) Read the full guide: https://x.com/affaanmustafa/status/2012378465664745795
101 lines
2.0 KiB
Markdown
101 lines
2.0 KiB
Markdown
# 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
|