@comfanion/workflow 3.7.2 → 3.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/build-info.json +1 -1
- package/src/opencode/config.yaml +1 -1
- package/src/opencode/skills/epic-writing/SKILL.md +41 -0
- package/src/opencode/skills/story-writing/SKILL.md +61 -0
- package/src/opencode/templates/epic-template.md +15 -2
- package/src/opencode/templates/story-template.md +20 -2
package/package.json
CHANGED
package/src/build-info.json
CHANGED
package/src/opencode/config.yaml
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
# PROJECT CONFIGURATION
|
|
7
7
|
# =============================================================================
|
|
8
8
|
project_name: "ai-wf"
|
|
9
|
-
version: "3.
|
|
9
|
+
version: "3.8.0"
|
|
10
10
|
|
|
11
11
|
# =============================================================================
|
|
12
12
|
# USER CONFIGURATION
|
|
@@ -18,6 +18,47 @@ Use this skill when you need to:
|
|
|
18
18
|
- Define epic-level acceptance criteria
|
|
19
19
|
- Track PRD coverage
|
|
20
20
|
|
|
21
|
+
## MANDATORY: Load Technical Context First
|
|
22
|
+
|
|
23
|
+
**Before writing ANY epic, you MUST read and understand:**
|
|
24
|
+
|
|
25
|
+
### 1. Project Architecture (REQUIRED)
|
|
26
|
+
```
|
|
27
|
+
Search and read in order:
|
|
28
|
+
1. CLAUDE.md (root) - Project patterns, conventions, tech stack
|
|
29
|
+
2. docs/architecture.md - System architecture, module boundaries
|
|
30
|
+
3. docs/architecture/[module]/ - Module-specific documentation
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### 2. Module/Domain Documentation (REQUIRED)
|
|
34
|
+
```
|
|
35
|
+
For the specific module this epic covers:
|
|
36
|
+
1. docs/architecture/[module]/index.md - Module overview
|
|
37
|
+
2. docs/architecture/[module]/architecture.md - Module architecture
|
|
38
|
+
3. docs/architecture/[module]/data-model.md - Database schema
|
|
39
|
+
4. docs/architecture/[module]/api/ - API contracts
|
|
40
|
+
5. docs/architecture/[module]/events/ - Event schemas
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### 3. PRD Requirements (REQUIRED)
|
|
44
|
+
```
|
|
45
|
+
1. docs/prd.md - Functional requirements (FR-XXX)
|
|
46
|
+
2. docs/requirements/ - Detailed requirements if exists
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Pre-Epic Checklist
|
|
50
|
+
|
|
51
|
+
Before writing epic, confirm you have read:
|
|
52
|
+
- [ ] CLAUDE.md - coding patterns and conventions
|
|
53
|
+
- [ ] Architecture document - system design
|
|
54
|
+
- [ ] Module documentation - specific module architecture
|
|
55
|
+
- [ ] PRD - requirements this epic implements
|
|
56
|
+
|
|
57
|
+
**⚠️ DO NOT proceed without reading technical documentation!**
|
|
58
|
+
**Epic MUST reference architecture sections and follow established patterns.**
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
21
62
|
## Template
|
|
22
63
|
|
|
23
64
|
Use template at: `@.opencode/templates/epic-template.md`
|
|
@@ -18,6 +18,67 @@ Use this skill when you need to:
|
|
|
18
18
|
- Define technical implementation tasks
|
|
19
19
|
- Specify test scenarios
|
|
20
20
|
|
|
21
|
+
## MANDATORY: Load Technical Standards First
|
|
22
|
+
|
|
23
|
+
**Before writing ANY story with tasks, you MUST read and understand:**
|
|
24
|
+
|
|
25
|
+
### 1. Coding Standards (REQUIRED)
|
|
26
|
+
```
|
|
27
|
+
Search and read in order:
|
|
28
|
+
1. CLAUDE.md (root) - Project patterns, code style, conventions
|
|
29
|
+
2. docs/coding-standards/ - Detailed coding standards
|
|
30
|
+
3. docs/coding-standards/testing-standards.md - Test patterns
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### 2. Module Architecture (REQUIRED)
|
|
34
|
+
```
|
|
35
|
+
For the specific module this story covers:
|
|
36
|
+
1. docs/architecture/[module]/architecture.md - Module design
|
|
37
|
+
2. docs/architecture/[module]/data-model.md - Database schema
|
|
38
|
+
3. Existing code in src/services/[module]/ - Current patterns
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### 3. Parent Epic (REQUIRED)
|
|
42
|
+
```
|
|
43
|
+
1. The epic this story belongs to - for context and dependencies
|
|
44
|
+
2. Other stories in the epic - for coordination
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Pre-Story Checklist
|
|
48
|
+
|
|
49
|
+
Before writing story tasks, confirm you have read:
|
|
50
|
+
- [ ] CLAUDE.md - coding patterns and file structure
|
|
51
|
+
- [ ] Coding standards - naming, error handling, testing
|
|
52
|
+
- [ ] Module architecture - component boundaries
|
|
53
|
+
- [ ] Parent epic - scope and dependencies
|
|
54
|
+
|
|
55
|
+
**⚠️ DO NOT write technical tasks without reading coding standards!**
|
|
56
|
+
**Tasks MUST follow project conventions and patterns from CLAUDE.md.**
|
|
57
|
+
|
|
58
|
+
### Task File Paths
|
|
59
|
+
|
|
60
|
+
When defining tasks, use EXACT paths following project structure:
|
|
61
|
+
```
|
|
62
|
+
src/services/[module]/
|
|
63
|
+
├── cmd/api/main.go
|
|
64
|
+
├── modules/[submodule]/
|
|
65
|
+
│ ├── domain/
|
|
66
|
+
│ │ ├── aggregate/[entity].go ← Domain entities
|
|
67
|
+
│ │ ├── valueobject/[vo].go ← Value objects
|
|
68
|
+
│ │ └── repository/[repo].go ← Repository interfaces
|
|
69
|
+
│ ├── application/
|
|
70
|
+
│ │ └── usecase/[UseCase]/ ← Use case (4 files)
|
|
71
|
+
│ │ ├── inport.go
|
|
72
|
+
│ │ ├── dto.go
|
|
73
|
+
│ │ ├── handler.go
|
|
74
|
+
│ │ └── mappers.go
|
|
75
|
+
│ └── infrastructure/
|
|
76
|
+
│ ├── repo/[entity]_postgres.go ← Repository impl
|
|
77
|
+
│ └── http/[handler].go ← HTTP handlers
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
21
82
|
## Template
|
|
22
83
|
|
|
23
84
|
Use template at: `@.opencode/templates/story-template.md`
|
|
@@ -24,10 +24,23 @@
|
|
|
24
24
|
**Enables (unlocks these):**
|
|
25
25
|
- [Epic ID]: [brief reason]
|
|
26
26
|
|
|
27
|
+
### Technical Documentation (MANDATORY)
|
|
28
|
+
|
|
29
|
+
**Documents used to create this epic:**
|
|
30
|
+
- [ ] `CLAUDE.md` - Project patterns and conventions
|
|
31
|
+
- [ ] `docs/architecture.md` - Section: [specific section]
|
|
32
|
+
- [ ] `docs/architecture/{{module}}/` - Module documentation
|
|
33
|
+
- [ ] `index.md` - Module overview
|
|
34
|
+
- [ ] `architecture.md` - Module design
|
|
35
|
+
- [ ] `data-model.md` - Database schema
|
|
36
|
+
- [ ] `api/` - API contracts
|
|
37
|
+
- [ ] `events/` - Event schemas
|
|
38
|
+
|
|
27
39
|
### Architecture References
|
|
28
40
|
|
|
29
|
-
- [Link to architecture section]
|
|
30
|
-
- [Link to data model]
|
|
41
|
+
- [Link to architecture section that this epic implements]
|
|
42
|
+
- [Link to data model section]
|
|
43
|
+
- [Link to API contracts if applicable]
|
|
31
44
|
|
|
32
45
|
### PRD Coverage
|
|
33
46
|
|
|
@@ -296,6 +296,22 @@ Settings → Editor → TODO → Add Pattern:
|
|
|
296
296
|
|
|
297
297
|
<!-- Context for the developer implementing this story -->
|
|
298
298
|
|
|
299
|
+
### Coding Standards Applied (MANDATORY)
|
|
300
|
+
|
|
301
|
+
**Standards documents used for this story:**
|
|
302
|
+
- [ ] `CLAUDE.md` - Project patterns, file structure, conventions
|
|
303
|
+
- [ ] `docs/coding-standards/` - Detailed coding standards
|
|
304
|
+
- [ ] Naming conventions
|
|
305
|
+
- [ ] Error handling patterns
|
|
306
|
+
- [ ] Testing patterns
|
|
307
|
+
- [ ] `docs/architecture/{{module}}/architecture.md` - Module-specific patterns
|
|
308
|
+
|
|
309
|
+
**Key patterns from CLAUDE.md:**
|
|
310
|
+
- File naming: `{{file_naming_pattern}}`
|
|
311
|
+
- Package structure: `{{package_structure}}`
|
|
312
|
+
- Error handling: `{{error_handling_pattern}}`
|
|
313
|
+
- Test file naming: `{{test_naming_pattern}}`
|
|
314
|
+
|
|
299
315
|
### Architecture Requirements
|
|
300
316
|
- Follow hexagonal architecture patterns
|
|
301
317
|
- Domain layer must not import infrastructure
|
|
@@ -314,10 +330,12 @@ Settings → Editor → TODO → Add Pattern:
|
|
|
314
330
|
### Reference Files
|
|
315
331
|
- `src/path/to/related/file` - [why relevant]
|
|
316
332
|
- `docs/architecture.md#section` - [architecture guidance]
|
|
333
|
+
- `CLAUDE.md#section` - [coding patterns]
|
|
317
334
|
|
|
318
335
|
### Patterns to Follow
|
|
319
|
-
-
|
|
320
|
-
- Follow
|
|
336
|
+
- **MANDATORY:** Follow patterns from `CLAUDE.md`
|
|
337
|
+
- **MANDATORY:** Follow `docs/coding-standards/`
|
|
338
|
+
- Match existing code style in module
|
|
321
339
|
|
|
322
340
|
### API/Interface
|
|
323
341
|
```
|