Initial Auto-Build plugin structure
This commit is contained in:
70
plugin/templates/CLAUDE.md.template
Normal file
70
plugin/templates/CLAUDE.md.template
Normal file
@@ -0,0 +1,70 @@
|
||||
# Project Context
|
||||
|
||||
## About
|
||||
[Brief description of this project]
|
||||
|
||||
## Tech Stack
|
||||
- **Language**: [e.g., Python 3.11, TypeScript 5.0]
|
||||
- **Framework**: [e.g., FastAPI, React, Vue.js]
|
||||
- **Build Tool**: [e.g., npm, poetry, gradle]
|
||||
- **Testing**: [e.g., pytest, vitest, jest]
|
||||
- **Database**: [e.g., PostgreSQL, Oracle, SQLite]
|
||||
|
||||
## Project Structure
|
||||
```
|
||||
/src # Source code
|
||||
/tests # Test files
|
||||
/docs # Documentation
|
||||
/config # Configuration
|
||||
```
|
||||
|
||||
## Common Commands
|
||||
```bash
|
||||
# Development
|
||||
npm run dev # Start dev server
|
||||
npm test # Run tests
|
||||
|
||||
# Build
|
||||
npm run build # Production build
|
||||
```
|
||||
|
||||
## Development Standards
|
||||
- [Add your coding standards here]
|
||||
- Use type annotations
|
||||
- Write tests for new features
|
||||
|
||||
## Workflows
|
||||
|
||||
### Feature Development
|
||||
1. Create feature branch: `git checkout -b feature/name`
|
||||
2. Write tests first (TDD)
|
||||
3. Implement feature
|
||||
4. Run tests and linting
|
||||
5. Create PR
|
||||
|
||||
## Boundaries
|
||||
|
||||
✅ **Always:**
|
||||
- Write tests for new features
|
||||
- Use type annotations
|
||||
- Document public APIs
|
||||
|
||||
⚠️ **Ask First:**
|
||||
- Modifying database schema
|
||||
- Changing API contracts
|
||||
- Major architectural changes
|
||||
|
||||
🚫 **Never:**
|
||||
- Commit secrets/credentials
|
||||
- Delete failing tests
|
||||
- Bypass CI checks
|
||||
- Push directly to main/master
|
||||
|
||||
## Common Gotchas
|
||||
[Add project-specific gotchas as you discover them]
|
||||
|
||||
---
|
||||
|
||||
# Auto-Build Integration
|
||||
@./.claude/rules/auto-build-patterns.md
|
||||
@./.claude/rules/auto-build-memory.md
|
||||
53
plugin/templates/memory-entry-template.json
Normal file
53
plugin/templates/memory-entry-template.json
Normal file
@@ -0,0 +1,53 @@
|
||||
{
|
||||
"pattern": {
|
||||
"id": "pat_{{TIMESTAMP_ID}}",
|
||||
"timestamp": "{{ISO_TIMESTAMP}}",
|
||||
"title": "{{Pattern Title}}",
|
||||
"description": "{{Detailed description of the pattern}}",
|
||||
"context": "{{Where/when this pattern was discovered}}",
|
||||
"example": {
|
||||
"file": "{{path/to/example/file}}",
|
||||
"lines": "{{start}}-{{end}}",
|
||||
"snippet": "{{Code snippet demonstrating the pattern}}"
|
||||
},
|
||||
"tags": ["{{tag1}}", "{{tag2}}", "{{tag3}}"],
|
||||
"feature": "{{feature-name}}",
|
||||
"usageCount": 0
|
||||
},
|
||||
|
||||
"gotcha": {
|
||||
"id": "got_{{TIMESTAMP_ID}}",
|
||||
"timestamp": "{{ISO_TIMESTAMP}}",
|
||||
"title": "{{Issue Title}}",
|
||||
"problem": "{{Description of the problem encountered}}",
|
||||
"solution": "{{How to solve/avoid the problem}}",
|
||||
"context": "{{When/where this was encountered}}",
|
||||
"tags": ["{{tag1}}", "{{tag2}}"],
|
||||
"feature": "{{feature-name}}"
|
||||
},
|
||||
|
||||
"codebase": {
|
||||
"id": "cb_{{TIMESTAMP_ID}}",
|
||||
"timestamp": "{{ISO_TIMESTAMP}}",
|
||||
"path": "{{directory/path/}}",
|
||||
"insight": "{{Structural insight about this part of codebase}}",
|
||||
"examples": ["{{Example1}}", "{{Example2}}"],
|
||||
"tags": ["{{tag1}}", "{{tag2}}"]
|
||||
},
|
||||
|
||||
"session": {
|
||||
"session_id": "ses_{{TIMESTAMP_ID}}",
|
||||
"timestamp": "{{ISO_TIMESTAMP}}",
|
||||
"feature": "{{feature-name}}",
|
||||
"duration": "{{Xh Ym}}",
|
||||
"insights_saved": [
|
||||
{"type": "pattern", "id": "{{pattern_id}}"},
|
||||
{"type": "gotcha", "id": "{{gotcha_id}}"}
|
||||
],
|
||||
"files_modified": [
|
||||
"{{path/to/file1}}",
|
||||
"{{path/to/file2}}"
|
||||
],
|
||||
"summary": "{{Brief summary of what was accomplished}}"
|
||||
}
|
||||
}
|
||||
123
plugin/templates/plan-template.md
Normal file
123
plugin/templates/plan-template.md
Normal file
@@ -0,0 +1,123 @@
|
||||
# Implementation Plan: {{FEATURE_NAME}}
|
||||
|
||||
## Overview
|
||||
|
||||
{{Brief summary of the implementation approach}}
|
||||
|
||||
## Task Order Summary
|
||||
|
||||
```
|
||||
1. {{Task 1 title}} (no dependencies)
|
||||
2. {{Task 2 title}} (depends on 1)
|
||||
3. {{Task 3 title}} (depends on 1)
|
||||
4. {{Task 4 title}} (depends on 2, 3)
|
||||
...
|
||||
```
|
||||
|
||||
## Dependency Graph
|
||||
|
||||
```
|
||||
Task 1 ──┬──> Task 2 ──┬──> Task 5
|
||||
│ │
|
||||
└──> Task 3 ──┘
|
||||
│
|
||||
└──> Task 4 ──────> Task 5
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Detailed Tasks
|
||||
|
||||
### Task 1: {{Title}}
|
||||
|
||||
**Objective**: {{One sentence describing what this task accomplishes}}
|
||||
|
||||
**Files**:
|
||||
- `{{path/to/file1}}` - {{what to do}}
|
||||
- `{{path/to/file2}}` - {{what to do}}
|
||||
|
||||
**Steps**:
|
||||
1. {{Specific step 1}}
|
||||
2. {{Specific step 2}}
|
||||
3. {{Specific step 3}}
|
||||
|
||||
**Dependencies**: None
|
||||
|
||||
**Completion Criteria**:
|
||||
- [ ] {{How to verify this task is done}}
|
||||
- [ ] {{Another verification}}
|
||||
|
||||
**Patterns to Follow**:
|
||||
- See `{{existing/similar/file}}` for reference
|
||||
|
||||
---
|
||||
|
||||
### Task 2: {{Title}}
|
||||
|
||||
**Objective**: {{One sentence}}
|
||||
|
||||
**Files**:
|
||||
- `{{path/to/file}}` - {{what to do}}
|
||||
|
||||
**Steps**:
|
||||
1. {{Specific step 1}}
|
||||
2. {{Specific step 2}}
|
||||
|
||||
**Dependencies**: Task 1
|
||||
|
||||
**Completion Criteria**:
|
||||
- [ ] {{Verification method}}
|
||||
|
||||
**Patterns to Follow**:
|
||||
- {{Reference to existing pattern}}
|
||||
|
||||
---
|
||||
|
||||
### Task N: {{Title}}
|
||||
|
||||
**Objective**: {{One sentence}}
|
||||
|
||||
**Files**:
|
||||
- `{{path/to/file}}` - {{what to do}}
|
||||
|
||||
**Steps**:
|
||||
1. {{Specific step}}
|
||||
|
||||
**Dependencies**: {{List task numbers}}
|
||||
|
||||
**Completion Criteria**:
|
||||
- [ ] {{Verification}}
|
||||
|
||||
---
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
### During Implementation
|
||||
|
||||
After each task, verify:
|
||||
- [ ] {{Quick check 1}}
|
||||
- [ ] {{Quick check 2}}
|
||||
|
||||
### Final Validation
|
||||
|
||||
- [ ] {{End-to-end test 1}}
|
||||
- [ ] {{End-to-end test 2}}
|
||||
- [ ] {{Manual verification step}}
|
||||
|
||||
## Risk Mitigation
|
||||
|
||||
| Risk | Detection | Response |
|
||||
|------|-----------|----------|
|
||||
| {{Risk from spec}} | {{How to detect early}} | {{What to do if it happens}} |
|
||||
|
||||
## Notes for Implementation
|
||||
|
||||
- {{Important consideration 1}}
|
||||
- {{Gotcha to watch out for}}
|
||||
- {{Pattern to follow consistently}}
|
||||
|
||||
---
|
||||
|
||||
*Generated by Auto-Build planner*
|
||||
*Date: {{TIMESTAMP}}*
|
||||
*Spec: {{SPEC_PATH}}*
|
||||
106
plugin/templates/spec-template.md
Normal file
106
plugin/templates/spec-template.md
Normal file
@@ -0,0 +1,106 @@
|
||||
# Feature: {{FEATURE_NAME}}
|
||||
|
||||
## Overview
|
||||
|
||||
{{Brief description of the feature and its value}}
|
||||
|
||||
## Problem Statement
|
||||
|
||||
{{What problem does this solve? Who benefits?}}
|
||||
|
||||
## User Stories
|
||||
|
||||
- As a {{user type}}, I want {{action}} so that {{benefit}}
|
||||
- As a {{user type}}, I want {{action}} so that {{benefit}}
|
||||
|
||||
## Functional Requirements
|
||||
|
||||
### Core Requirements (Must Have)
|
||||
|
||||
1. {{Requirement 1}}
|
||||
2. {{Requirement 2}}
|
||||
3. {{Requirement 3}}
|
||||
|
||||
### Secondary Requirements (Nice to Have)
|
||||
|
||||
1. {{Requirement 1}}
|
||||
2. {{Requirement 2}}
|
||||
|
||||
## Technical Requirements
|
||||
|
||||
### Files to Modify
|
||||
|
||||
| File | Changes |
|
||||
|------|---------|
|
||||
| `{{path/to/file1}}` | {{What to change}} |
|
||||
| `{{path/to/file2}}` | {{What to change}} |
|
||||
|
||||
### New Files to Create
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `{{path/to/new/file}}` | {{What this file does}} |
|
||||
|
||||
### Dependencies
|
||||
|
||||
- {{Existing module/library to use}}
|
||||
- {{New dependency if needed}}
|
||||
|
||||
### Database Changes
|
||||
|
||||
{{None / Describe any schema changes, migrations, or queries}}
|
||||
|
||||
### API Changes
|
||||
|
||||
{{None / Describe new endpoints or modifications to existing ones}}
|
||||
|
||||
## Design Decisions
|
||||
|
||||
### Chosen Approach
|
||||
|
||||
{{Why this approach was selected}}
|
||||
|
||||
### Alternatives Considered
|
||||
|
||||
| Alternative | Pros | Cons | Why Not Chosen |
|
||||
|-------------|------|------|----------------|
|
||||
| {{Option A}} | {{Pros}} | {{Cons}} | {{Reason}} |
|
||||
| {{Option B}} | {{Pros}} | {{Cons}} | {{Reason}} |
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- [ ] {{Testable criterion 1}}
|
||||
- [ ] {{Testable criterion 2}}
|
||||
- [ ] {{Testable criterion 3}}
|
||||
- [ ] {{Testable criterion 4}}
|
||||
|
||||
## Out of Scope
|
||||
|
||||
The following are explicitly NOT included in this feature:
|
||||
|
||||
- {{Item 1}}
|
||||
- {{Item 2}}
|
||||
- {{Future enhancement to consider later}}
|
||||
|
||||
## Risks and Mitigations
|
||||
|
||||
| Risk | Likelihood | Impact | Mitigation |
|
||||
|------|------------|--------|------------|
|
||||
| {{Risk 1}} | Low/Medium/High | Low/Medium/High | {{How to mitigate}} |
|
||||
| {{Risk 2}} | Low/Medium/High | Low/Medium/High | {{How to mitigate}} |
|
||||
|
||||
## Open Questions
|
||||
|
||||
- [ ] {{Question that needs clarification}}
|
||||
- [ ] {{Another open question}}
|
||||
|
||||
## Estimated Complexity
|
||||
|
||||
**{{Low / Medium / High}}**
|
||||
|
||||
Justification: {{Brief explanation of complexity assessment}}
|
||||
|
||||
---
|
||||
|
||||
*Generated by Auto-Build spec-writer*
|
||||
*Date: {{TIMESTAMP}}*
|
||||
Reference in New Issue
Block a user