b2acc9b115
### New Content - Learning Paths section in README (Junior/Senior/Power User/PM tracks) - examples/ folder with 18 ready-to-use templates: - 4 agents (code-reviewer, test-writer, security-auditor, refactoring) - 2 skills (TDD workflow, security checklist) - 3 commands (commit, review-pr, generate-tests) - 4 hooks (bash + PowerShell for security, formatting) - 3 config templates (settings, MCP, gitignore) - 2 memory templates (project + personal CLAUDE.md) ### Governance - CHANGELOG.md: Version history (1.0.0 → 1.1.0 → Unreleased) - CONTRIBUTING.md: Contribution guidelines for community ### Documentation - llms.txt: Updated structure with new files/folders This update makes the guide more actionable with concrete templates and provides clear learning paths for different skill levels. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
71 lines
1.5 KiB
Text
71 lines
1.5 KiB
Text
# Project Memory - [Project Name]
|
|
|
|
> This file provides Claude with persistent context about your project.
|
|
> Place at: ./CLAUDE.md (project root) for team conventions.
|
|
|
|
## Project Overview
|
|
|
|
**Name**: [Project Name]
|
|
**Type**: [Web app / API / CLI / Library]
|
|
**Stack**: [e.g., TypeScript, Next.js, Prisma, PostgreSQL]
|
|
|
|
## Architecture
|
|
|
|
```
|
|
src/
|
|
├── app/ # Next.js app router
|
|
├── components/ # React components
|
|
├── lib/ # Shared utilities
|
|
├── services/ # Business logic
|
|
└── types/ # TypeScript types
|
|
```
|
|
|
|
## Conventions
|
|
|
|
### Code Style
|
|
- Use TypeScript strict mode
|
|
- Prefer `const` over `let`
|
|
- Use named exports
|
|
- Maximum function length: 30 lines
|
|
|
|
### Naming
|
|
- Files: `kebab-case.ts`
|
|
- Components: `PascalCase.tsx`
|
|
- Functions: `camelCase`
|
|
- Constants: `SCREAMING_SNAKE_CASE`
|
|
|
|
### Git
|
|
- Branch format: `type/description` (e.g., `feat/user-auth`)
|
|
- Commit format: Conventional Commits
|
|
- PR required for main branch
|
|
|
|
## Key Files
|
|
|
|
- `@src/lib/db.ts` - Database connection
|
|
- `@src/services/auth.ts` - Authentication logic
|
|
- `@docs/api.md` - API documentation
|
|
|
|
## Testing
|
|
|
|
- Framework: Vitest
|
|
- Run: `npm test`
|
|
- Coverage target: 80%
|
|
|
|
## Commands
|
|
|
|
```bash
|
|
npm run dev # Development server
|
|
npm run build # Production build
|
|
npm run test # Run tests
|
|
npm run lint # Lint code
|
|
```
|
|
|
|
## Known Issues
|
|
|
|
- [Issue description and workaround if any]
|
|
|
|
## Team Contacts
|
|
|
|
- **Tech Lead**: [Name]
|
|
- **Backend**: [Name]
|
|
- **Frontend**: [Name]
|