feat: add Learning Paths, examples, and project governance files
### 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>
This commit is contained in:
parent
a4eed95f47
commit
b2acc9b115
24 changed files with 1744 additions and 4 deletions
68
examples/memory/CLAUDE.md.personal-template
Normal file
68
examples/memory/CLAUDE.md.personal-template
Normal file
|
|
@ -0,0 +1,68 @@
|
|||
# Personal Claude Memory
|
||||
|
||||
> This file provides Claude with your personal preferences.
|
||||
> Place at: ~/.claude/CLAUDE.md (global, applies to all projects).
|
||||
|
||||
## Communication Style
|
||||
|
||||
- Be concise and direct
|
||||
- Use code examples over explanations
|
||||
- Challenge my assumptions when needed
|
||||
- Don't over-explain obvious things
|
||||
|
||||
## Development Preferences
|
||||
|
||||
### Languages & Frameworks
|
||||
- Primary: TypeScript, React, Node.js
|
||||
- Secondary: Python, Go
|
||||
- Preferred test framework: Vitest/Jest
|
||||
|
||||
### Code Style
|
||||
- Prefer functional programming
|
||||
- Use early returns
|
||||
- Keep functions small
|
||||
- Meaningful variable names over comments
|
||||
|
||||
### Tools
|
||||
- Editor: VS Code
|
||||
- Terminal: iTerm2 / Windows Terminal
|
||||
- Version control: Git
|
||||
|
||||
## Workflow Preferences
|
||||
|
||||
### When Writing Code
|
||||
- Always include type definitions
|
||||
- Add error handling
|
||||
- Write tests for critical paths
|
||||
- Use async/await over callbacks
|
||||
|
||||
### When Reviewing
|
||||
- Focus on logic and security first
|
||||
- Style suggestions are secondary
|
||||
- Point out potential edge cases
|
||||
|
||||
### When Debugging
|
||||
- Show me the investigation process
|
||||
- Explain your reasoning
|
||||
- Suggest multiple solutions if applicable
|
||||
|
||||
## Common Shortcuts
|
||||
|
||||
- `cc` → `claude`
|
||||
- `gcm` → `git commit -m`
|
||||
- `gp` → `git push`
|
||||
|
||||
## Pet Peeves
|
||||
|
||||
- Don't add unnecessary comments
|
||||
- Don't over-engineer simple solutions
|
||||
- Don't ignore error handling
|
||||
- Don't use `any` in TypeScript
|
||||
|
||||
## Learning Goals
|
||||
|
||||
- [Current focus areas for learning]
|
||||
|
||||
## Notes
|
||||
|
||||
- [Any other personal notes for Claude]
|
||||
71
examples/memory/CLAUDE.md.project-template
Normal file
71
examples/memory/CLAUDE.md.project-template
Normal file
|
|
@ -0,0 +1,71 @@
|
|||
# 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]
|
||||
Loading…
Add table
Add a link
Reference in a new issue