Project Context¶
This file provides project-specific context to Claude Code agents.
When amplihack is installed in your project, customize this file to describe YOUR project. This helps agents understand what you're building and provide better assistance.
Quick Start¶
Replace the sections below with information about your project.
Project: [Your Project Name]¶
Overview¶
[Brief description of what your project does]
Architecture¶
Key Components¶
- Component 1: [Purpose and responsibilities]
- Component 2: [Purpose and responsibilities]
- Component 3: [Purpose and responsibilities]
Technology Stack¶
- Language: [Primary language(s)]
- Framework: [Main framework if applicable]
- Database: [Database system if applicable]
- Other Tools: [Key dependencies or tools]
Development Guidelines¶
Code Organization¶
[How is your code organized? What are the main directories?]
Key Patterns¶
[What architectural patterns or conventions does your project follow?]
Testing Strategy¶
[How do you test? Unit tests, integration tests, E2E?]
Domain Knowledge¶
Business Context¶
[What problem does this project solve? Who are the users?]
Key Terminology¶
[Important domain-specific terms that agents should understand]
Common Tasks¶
Development Workflow¶
[How do developers typically work on this project?]
Deployment Process¶
[How is the project deployed?]
Important Notes¶
[Any special considerations, gotchas, or critical information]
About This File¶
This file is installed by amplihack to provide project-specific context to AI agents.
For more about amplihack itself, see PROJECT_AMPLIHACK.md in this directory.
Tip: Keep this file updated as your project evolves. Accurate context leads to better AI assistance.