Skip to content

Commit 0ffa188

Browse files
committed
refactor: update documentation for interface contracts and integration patterns
1 parent d0c6118 commit 0ffa188

4 files changed

Lines changed: 11 additions & 10 deletions

File tree

templates/commands/plan.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,11 @@ You **MUST** consider the user input before proceeding (if not empty).
7575
- Validation rules from requirements
7676
- State transitions if applicable
7777

78-
2. **Generate API contracts** from functional requirements:
79-
- For each user action → endpoint
80-
- Use standard REST/GraphQL patterns
81-
- Output OpenAPI/GraphQL schema to `/contracts/`
78+
2. **Define interface contracts** (if project has external interfaces) → `/contracts/`:
79+
- Identify what interfaces the project exposes to users or other systems
80+
- Document the contract format appropriate for the project type
81+
- Examples: public APIs for libraries, command schemas for CLI tools, endpoints for web services, grammars for parsers, UI contracts for applications
82+
- Skip if project is purely internal (build scripts, one-off tools, etc.)
8283

8384
3. **Agent context update**:
8485
- Run `{AGENT_SCRIPT}`

templates/commands/specify.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ When creating this spec from a user prompt:
235235
- Performance targets: Standard web/mobile app expectations unless specified
236236
- Error handling: User-friendly messages with appropriate fallbacks
237237
- Authentication method: Standard session-based or OAuth2 for web apps
238-
- Integration patterns: RESTful APIs unless specified otherwise
238+
- Integration patterns: Use project-appropriate patterns (REST/GraphQL for web services, function calls for libraries, CLI args for tools, etc.)
239239
240240
### Success Criteria Guidelines
241241

templates/commands/tasks.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ You **MUST** consider the user input before proceeding (if not empty).
2828

2929
2. **Load design documents**: Read from FEATURE_DIR:
3030
- **Required**: plan.md (tech stack, libraries, structure), spec.md (user stories with priorities)
31-
- **Optional**: data-model.md (entities), contracts/ (API endpoints), research.md (decisions), quickstart.md (test scenarios)
31+
- **Optional**: data-model.md (entities), contracts/ (interface definitions), research.md (decisions), quickstart.md (test scenarios)
3232
- Note: Not all projects have all documents. Generate tasks based on what's available.
3333

3434
3. **Execute task generation workflow**:
3535
- Load plan.md and extract tech stack, libraries, project structure
3636
- Load spec.md and extract user stories with their priorities (P1, P2, P3, etc.)
3737
- If data-model.md exists: Extract entities and map to user stories
38-
- If contracts/ exists: Map endpoints to user stories
38+
- If contracts/ exists: Map interface contracts to user stories
3939
- If research.md exists: Extract decisions for setup tasks
4040
- Generate tasks organized by user story (see Task Generation Rules below)
4141
- Generate dependency graph showing user story completion order
@@ -112,12 +112,12 @@ Every task MUST strictly follow this format:
112112
- Map all related components to their story:
113113
- Models needed for that story
114114
- Services needed for that story
115-
- Endpoints/UI needed for that story
115+
- Interfaces/UI needed for that story
116116
- If tests requested: Tests specific to that story
117117
- Mark story dependencies (most stories should be independent)
118118

119119
2. **From Contracts**:
120-
- Map each contract/endpoint → to the user story it serves
120+
- Map each contract/interface → to the user story it serves
121121
- If tests requested: Each contract → contract test task [P] before implementation in that story's phase
122122

123123
3. **From Data Model**:

templates/plan-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
**Storage**: [if applicable, e.g., PostgreSQL, CoreData, files or N/A]
2323
**Testing**: [e.g., pytest, XCTest, cargo test or NEEDS CLARIFICATION]
2424
**Target Platform**: [e.g., Linux server, iOS 15+, WASM or NEEDS CLARIFICATION]
25-
**Project Type**: [single/web/mobile - determines source structure]
25+
**Project Type**: [e.g., library/cli/web-service/mobile-app/compiler/desktop-app or NEEDS CLARIFICATION]
2626
**Performance Goals**: [domain-specific, e.g., 1000 req/s, 10k lines/sec, 60 fps or NEEDS CLARIFICATION]
2727
**Constraints**: [domain-specific, e.g., <200ms p95, <100MB memory, offline-capable or NEEDS CLARIFICATION]
2828
**Scale/Scope**: [domain-specific, e.g., 10k users, 1M LOC, 50 screens or NEEDS CLARIFICATION]

0 commit comments

Comments
 (0)