Skip to content

Commit 1dd8326

Browse files
committed
Fix agents.md copy
1 parent e823483 commit 1dd8326

File tree

2 files changed

+52
-1
lines changed

2 files changed

+52
-1
lines changed

src/lib/TemplateManager.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ export class TemplateManager {
7171
const copiedFiles: string[] = [];
7272

7373
try {
74-
const contextSource = path.join(this.templatesDir, 'env', 'AGENTS.md');
74+
const contextSource = path.join(this.templatesDir, 'env', 'base.md');
7575
const contextTarget = path.join(this.targetDir, env.contextFileName);
7676

7777
if (await fs.pathExists(contextSource)) {

templates/env/base.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# AI DevKit Rules
2+
3+
## Project Context
4+
This project uses ai-devkit for structured AI-assisted development. Phase documentation is located in `docs/ai/`.
5+
6+
## Documentation Structure
7+
- `docs/ai/requirements/` - Problem understanding and requirements
8+
- `docs/ai/design/` - System architecture and design decisions (include mermaid diagrams)
9+
- `docs/ai/planning/` - Task breakdown and project planning
10+
- `docs/ai/implementation/` - Implementation guides and notes
11+
- `docs/ai/testing/` - Testing strategy and test cases
12+
- `docs/ai/deployment/` - Deployment and infrastructure docs
13+
- `docs/ai/monitoring/` - Monitoring and observability setup
14+
15+
## Code Style & Standards
16+
- Follow the project's established code style and conventions
17+
- Write clear, self-documenting code with meaningful variable names
18+
- Add comments for complex logic or non-obvious decisions
19+
20+
## Development Workflow
21+
- Review phase documentation in `docs/ai/` before implementing features
22+
- Keep requirements, design, and implementation docs updated as the project evolves
23+
- Reference the planning doc for task breakdown and priorities
24+
- Copy the testing template (`docs/ai/testing/README.md`) before creating feature-specific testing docs
25+
26+
## AI Interaction Guidelines
27+
- When implementing features, first check relevant phase documentation
28+
- For new features, start with requirements clarification
29+
- Update phase docs when significant changes or decisions are made
30+
31+
## Testing & Quality
32+
- Write tests alongside implementation
33+
- Follow the testing strategy defined in `docs/ai/testing/`
34+
- Use `/writing-test` to generate unit and integration tests targeting 100% coverage
35+
- Ensure code passes all tests before considering it complete
36+
37+
## Documentation
38+
- Update phase documentation when requirements or design changes
39+
- Keep inline code comments focused and relevant
40+
- Document architectural decisions and their rationale
41+
- Use mermaid diagrams for any architectural or data-flow visuals (update existing diagrams if needed)
42+
- Record test coverage results and outstanding gaps in `docs/ai/testing/`
43+
44+
## Key Commands
45+
When working on this project, you can run commands to:
46+
- Understand project requirements and goals (`review-requirements`)
47+
- Review architectural decisions (`review-design`)
48+
- Plan and execute tasks (`execute-plan`)
49+
- Verify implementation against design (`check-implementation`)
50+
- Suggest missing tests (`suggest-tests`)
51+
- Perform structured code reviews (`code-review`)

0 commit comments

Comments
 (0)