ce-workflow 0.4.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/agent-core/docs/path-resolution.md +105 -0
- package/agent-core/prompts/_base.md +103 -0
- package/agent-core/prompts/cleanup.md +199 -0
- package/agent-core/prompts/design.md +474 -0
- package/agent-core/prompts/develop.md +229 -0
- package/agent-core/prompts/doctor.md +204 -0
- package/agent-core/prompts/documentation.md +71 -0
- package/agent-core/prompts/init.md +176 -0
- package/agent-core/prompts/orchestrator.md +219 -0
- package/agent-core/prompts/sync.md +48 -0
- package/agent-core/templates/docs/.gitkeep +1 -0
- package/agent-core/templates/doctor_output.md +138 -0
- package/agent-core/templates/documentation_output.md +71 -0
- package/agent-core/templates/executor_output.md +64 -0
- package/agent-core/templates/init_output.md +307 -0
- package/agent-core/templates/meta.template.json +54 -0
- package/agent-core/templates/orchestrator_output.md +51 -0
- package/agent-core/templates/planning_output.md +190 -0
- package/agent-core/templates/research_output.md +167 -0
- package/bin/ce-workflow.js +2 -0
- package/dist/index.js +4197 -0
- package/package.json +67 -0
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: CE-Workflow Sync
|
|
3
|
+
description: Reconcile project state with the CE-Workflow knowledge base and update semantic index.
|
|
4
|
+
argument-hint: "[SCOPE=<path|module>]"
|
|
5
|
+
tools: ['resolve_path', 'get_context_bundle', 'search_knowledge', 'search_code', 'get_project_context', 'index_knowledge', 'list_projects', 'update_task', 'read', 'write', 'glob', 'grep']
|
|
6
|
+
required-args: []
|
|
7
|
+
optional-args:
|
|
8
|
+
- name: SCOPE
|
|
9
|
+
default: ""
|
|
10
|
+
auto-identity:
|
|
11
|
+
user: "$GIT_USER"
|
|
12
|
+
model: "$AGENT_MODEL"
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
You are the Knowledge Sync Lead. Act like a senior architect charged with keeping the CE-Workflow knowledge cache authoritative and current.
|
|
16
|
+
|
|
17
|
+
## Pipeline Position
|
|
18
|
+
- **Maintenance Agent**: Runs periodically or after significant codebase changes
|
|
19
|
+
- **Requires**: Init must have been run at least once (`project-context.md` must exist)
|
|
20
|
+
- **Triggers Init**: If major structural changes detected, recommend running `/init`
|
|
21
|
+
|
|
22
|
+
## Prerequisites (STRICT)
|
|
23
|
+
Check `{{CE_DATA}}/knowledge/project-context.md` exists.
|
|
24
|
+
- If missing: "Project context not found. Please run `/init` first."
|
|
25
|
+
|
|
26
|
+
## Mission
|
|
27
|
+
- Inspect the live codebase to understand the present implementation and recent changes
|
|
28
|
+
- Align the knowledge base so every entry reflects the latest reality
|
|
29
|
+
|
|
30
|
+
Non-Negotiables
|
|
31
|
+
1. Perform your own discovery; read source files, configs, and docs directly—do not rely on prior summaries.
|
|
32
|
+
2. Cross-check each relevant knowledge entry against the code. Update, merge, or delete content so no contradictions remain.
|
|
33
|
+
3. Version every knowledge edit by stamping an ISO date (e.g. `Updated: 2024-11-01`) near the top of the section you modify.
|
|
34
|
+
4. Keep all knowledge files lean (<500 lines each) and focused on durable insights, linking to code paths or task artifacts instead of duplicating detail.
|
|
35
|
+
5. Record gaps or follow-up items in a checklist inside the file you touched so future runs can close them.
|
|
36
|
+
6. **Semantic Indexing (MANDATORY)**: After updating any knowledge files, run the indexer to keep search current.
|
|
37
|
+
|
|
38
|
+
## Reindexing Guidance
|
|
39
|
+
|
|
40
|
+
| Scenario | Tool Argument | Rationale |
|
|
41
|
+
|----------|---------------|-----------|
|
|
42
|
+
| Routine updates | `{ "project": "{{WORKSPACE_NAME}}" }` | Incremental (fastest). Only updates changed files. |
|
|
43
|
+
| Major refactors | `{ "project": "{{WORKSPACE_NAME}}", "force": true }` | Forces re-calculation of hashes for all files without wiping. |
|
|
44
|
+
| Corrupt index / Stale vectors | `{ "project": "{{WORKSPACE_NAME}}", "clean": true }` | Wipes index files and rebuilds from scratch. Resolves vector drift. |
|
|
45
|
+
|
|
46
|
+
Deliverable
|
|
47
|
+
- Updated `{{CE_DATA}}/knowledge/*` files that accurately reflect the present project state, each carrying the latest `Updated:` marker and lean checklist.
|
|
48
|
+
- Optional supporting notes saved alongside the knowledge files if deeper context is required; keep these under 500 lines as well.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
TEMPLATE: Project Diagnosis
|
|
3
|
+
|
|
4
|
+
HOW TO USE:
|
|
5
|
+
1. Copy to: {{CE_DATA}}/tasks/doctor-{{YYYYMMDD}}/diagnosis.md
|
|
6
|
+
2. Replace {{variable}} placeholders with actual values
|
|
7
|
+
3. Add findings under appropriate priority sections
|
|
8
|
+
4. Remove empty sections and placeholder rows
|
|
9
|
+
|
|
10
|
+
SYSTEM PATH VARIABLES (Must be replaced by agent using System Resolved Paths):
|
|
11
|
+
- {{CE_DATA}}: Storage path for knowledge/tasks (Use value from system context!)
|
|
12
|
+
- {{WORKSPACE_ROOT}}: Source code directory
|
|
13
|
+
|
|
14
|
+
AGENT-FILLED VARIABLES:
|
|
15
|
+
- {{project_name}}: Name of the project
|
|
16
|
+
- {{date}}: ISO date (YYYY-MM-DD)
|
|
17
|
+
- {{author}}: Git user or agent name (analyst)
|
|
18
|
+
- {{workspace_root}}: Source code directory
|
|
19
|
+
- {{focus_area}}: Focus area parameter or "General"
|
|
20
|
+
-->
|
|
21
|
+
# Project Diagnosis – {{project_name}}
|
|
22
|
+
|
|
23
|
+
- Diagnosis Date: `{{date}}`
|
|
24
|
+
- Analyst: `{{author}}`
|
|
25
|
+
- Workspace: `{{workspace_root}}`
|
|
26
|
+
- Focus Area: `{{focus_area}}` (or "General" if not specified)
|
|
27
|
+
- Project Context: `{{CE_DATA}}/knowledge/project-context.md`
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## Executive Summary
|
|
32
|
+
|
|
33
|
+
A brief 2-3 sentence summary of the overall codebase health and most critical findings.
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## Health Score
|
|
38
|
+
|
|
39
|
+
| Category | Score (1-5) | Notes |
|
|
40
|
+
|----------|-------------|-------|
|
|
41
|
+
| Code Quality | | |
|
|
42
|
+
| Architecture | | |
|
|
43
|
+
| Testing | | |
|
|
44
|
+
| Security | | |
|
|
45
|
+
| Performance | | |
|
|
46
|
+
| Maintainability | | |
|
|
47
|
+
| **Overall** | | |
|
|
48
|
+
|
|
49
|
+
*Scale: 1=Critical issues, 2=Significant issues, 3=Acceptable, 4=Good, 5=Excellent*
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## Critical Findings (P0-P1)
|
|
54
|
+
|
|
55
|
+
### Finding 1: [Title]
|
|
56
|
+
- **Category**: (Code Quality / Architecture / Testing / Security / Performance)
|
|
57
|
+
- **Priority**: P0 / P1
|
|
58
|
+
- **Impact**: High
|
|
59
|
+
- **Effort**: Low / Medium / High
|
|
60
|
+
- **Location**: `path/to/file.ts:L42-L100`
|
|
61
|
+
- **Description**: What is the problem?
|
|
62
|
+
- **Evidence**: Code snippets, metrics, or specific examples.
|
|
63
|
+
- **Recommendation**: What should be done?
|
|
64
|
+
- **Acceptance Criteria**:
|
|
65
|
+
- [ ] Criterion 1
|
|
66
|
+
- [ ] Criterion 2
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## Medium Priority Findings (P2)
|
|
71
|
+
|
|
72
|
+
### Finding N: [Title]
|
|
73
|
+
- **Category**:
|
|
74
|
+
- **Priority**: P2
|
|
75
|
+
- **Impact**: Medium
|
|
76
|
+
- **Effort**:
|
|
77
|
+
- **Description**:
|
|
78
|
+
- **Recommendation**:
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## Low Priority / Backlog (P3+)
|
|
83
|
+
|
|
84
|
+
| Finding | Category | Effort | Notes |
|
|
85
|
+
|---------|----------|--------|-------|
|
|
86
|
+
| | | | |
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## Recommended Tasks for Planning Agent
|
|
91
|
+
|
|
92
|
+
> These are ready-to-use task definitions for the `planning` agent.
|
|
93
|
+
|
|
94
|
+
### Task 1: [Suggested Title]
|
|
95
|
+
```yaml
|
|
96
|
+
title: "[ACTION] [COMPONENT]: [Goal]"
|
|
97
|
+
priority: P1
|
|
98
|
+
category: refactoring / bugfix / feature / docs
|
|
99
|
+
description: |
|
|
100
|
+
Brief description of what needs to be done and why.
|
|
101
|
+
acceptance_criteria:
|
|
102
|
+
- Criterion 1
|
|
103
|
+
- Criterion 2
|
|
104
|
+
estimated_effort: "2-4 hours / 1-2 days / 1 week"
|
|
105
|
+
dependencies:
|
|
106
|
+
- Any blocking tasks or requirements
|
|
107
|
+
context_artifacts:
|
|
108
|
+
- "{{CE_DATA}}/knowledge/project-context.md"
|
|
109
|
+
- "path/to/relevant/file.ts"
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### Task 2: [Suggested Title]
|
|
113
|
+
```yaml
|
|
114
|
+
# ... repeat format
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## Metrics & Data
|
|
120
|
+
|
|
121
|
+
Any relevant metrics collected during analysis:
|
|
122
|
+
- Lines of code:
|
|
123
|
+
- Files analyzed:
|
|
124
|
+
- Test coverage (if available):
|
|
125
|
+
- Dependency count:
|
|
126
|
+
- TODO/FIXME comments found:
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## Next Steps
|
|
131
|
+
|
|
132
|
+
1. Review findings with team/stakeholder
|
|
133
|
+
2. Hand off high-priority tasks to `planning` agent: `ce-workflow run planning --task="<Task Title>"`
|
|
134
|
+
3. Schedule follow-up diagnosis in: [timeframe]
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
> This diagnosis is based on automated analysis and code review. Human judgment should validate recommendations before implementation.
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
TEMPLATE: Handover Note / Documentation
|
|
3
|
+
|
|
4
|
+
HOW TO USE:
|
|
5
|
+
1. Copy to destination based on DOC_TYPE:
|
|
6
|
+
- With TASK_SLUG: {{CE_DATA}}/tasks/{{TASK_SLUG}}/docs/{{TASK_SLUG}}-{{DOC_TYPE}}.md
|
|
7
|
+
- With TARGET_PATH: {{CE_DATA}}/{{TARGET_PATH}}
|
|
8
|
+
- Default: {{CE_DATA}}/knowledge/{{DOC_TYPE}}.md
|
|
9
|
+
2. Replace {{variable}} placeholders with actual values
|
|
10
|
+
3. Remove empty sections
|
|
11
|
+
|
|
12
|
+
SYSTEM PATH VARIABLES (Must be replaced by agent using System Resolved Paths):
|
|
13
|
+
- {{CE_DATA}}: Storage path for knowledge/tasks (Use value from system context!)
|
|
14
|
+
- {{WORKSPACE_NAME}}: Project name
|
|
15
|
+
|
|
16
|
+
AGENT-FILLED VARIABLES:
|
|
17
|
+
- {{task_id}}: UUID for the task (if applicable)
|
|
18
|
+
- {{task_slug}}: kebab-case task identifier (if applicable)
|
|
19
|
+
- {{task_title}}: Human-readable task title
|
|
20
|
+
- {{author}}: Git user or agent name
|
|
21
|
+
- {{date}}: ISO date (YYYY-MM-DD)
|
|
22
|
+
- {{execution_artifact}}: Path to execution log
|
|
23
|
+
- {{release_ref}}: Release tag or commit SHA
|
|
24
|
+
- {{workspace_name}}: Project name
|
|
25
|
+
-->
|
|
26
|
+
# Handover Note – {{task_title}}
|
|
27
|
+
|
|
28
|
+
- Task ID: `{{task_id}}`
|
|
29
|
+
- Task Slug: `{{task_slug}}`
|
|
30
|
+
- Author: `{{author}}`
|
|
31
|
+
- Date: `{{date}}`
|
|
32
|
+
- Execution Artifact: `{{execution_artifact}}`
|
|
33
|
+
- Release / Merge Reference: `{{release_ref}}`
|
|
34
|
+
- Workspace: `{{workspace_name}}`
|
|
35
|
+
|
|
36
|
+
## 1. Overview
|
|
37
|
+
- Purpose of the work and high-level outcome.
|
|
38
|
+
- Linked research, plan, and execution documents.
|
|
39
|
+
|
|
40
|
+
## Checklist
|
|
41
|
+
- [ ] Replace with sign-off requirement.
|
|
42
|
+
- [ ] Replace with follow-up confirmation.
|
|
43
|
+
|
|
44
|
+
## 2. Implementation Details
|
|
45
|
+
- Summary of major code changes and affected components.
|
|
46
|
+
- Feature flags, configuration updates, or migrations.
|
|
47
|
+
|
|
48
|
+
## 3. Validation Evidence
|
|
49
|
+
- Tests executed and results.
|
|
50
|
+
- Monitoring or telemetry instructions post-release.
|
|
51
|
+
|
|
52
|
+
## 4. Decisions & Rationale
|
|
53
|
+
- Final decisions made with references.
|
|
54
|
+
- Deferred items or future considerations.
|
|
55
|
+
|
|
56
|
+
## 5. Knowledge Sync
|
|
57
|
+
- Updates pushed to `{{CE_DATA}}/knowledge` with file references.
|
|
58
|
+
- External documentation or runbooks updated.
|
|
59
|
+
|
|
60
|
+
## 6. Operational Notes
|
|
61
|
+
- Deployment steps, rollback plan, and ownership.
|
|
62
|
+
- Support contacts or escalation paths.
|
|
63
|
+
|
|
64
|
+
## 7. Follow-up Actions
|
|
65
|
+
- Outstanding tasks or bugs.
|
|
66
|
+
- Recommendations for future improvements.
|
|
67
|
+
|
|
68
|
+
## 8. Sign-off
|
|
69
|
+
- Confirmation of readiness and any approvals obtained.
|
|
70
|
+
|
|
71
|
+
> Keep this handover document under 500 lines. Ensure all links are relative paths when possible.
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
TEMPLATE: Execution Log
|
|
3
|
+
|
|
4
|
+
HOW TO USE:
|
|
5
|
+
1. Copy to: {{CE_DATA}}/tasks/{{TASK_SLUG}}/execution/{{TASK_SLUG}}-execution.md
|
|
6
|
+
2. Replace {{variable}} placeholders with actual values
|
|
7
|
+
3. Update Implementation Steps table as work progresses
|
|
8
|
+
4. Remove empty sections
|
|
9
|
+
|
|
10
|
+
SYSTEM PATH VARIABLES (Must be replaced by agent using System Resolved Paths):
|
|
11
|
+
- {{CE_DATA}}: Storage path for knowledge/tasks (Use value from system context!)
|
|
12
|
+
- {{WORKSPACE_NAME}}: Project name
|
|
13
|
+
|
|
14
|
+
AGENT-FILLED VARIABLES:
|
|
15
|
+
- {{task_id}}: UUID for the task
|
|
16
|
+
- {{task_slug}}: kebab-case task identifier
|
|
17
|
+
- {{task_title}}: Human-readable task title
|
|
18
|
+
- {{author}}: Git user or agent name (executor)
|
|
19
|
+
- {{date}}: ISO date (YYYY-MM-DD)
|
|
20
|
+
- {{plan_artifact}}: Path to execution plan
|
|
21
|
+
- {{git_ref}}: Branch name or commit SHA
|
|
22
|
+
- {{workspace_name}}: Project name
|
|
23
|
+
-->
|
|
24
|
+
# Execution Log – {{task_title}}
|
|
25
|
+
|
|
26
|
+
- Task ID: `{{task_id}}`
|
|
27
|
+
- Task Slug: `{{task_slug}}`
|
|
28
|
+
- Executor: `{{author}}`
|
|
29
|
+
- Date: `{{date}}`
|
|
30
|
+
- Plan Artifact: `{{plan_artifact}}`
|
|
31
|
+
- Branch / Commit Reference: `{{git_ref}}`
|
|
32
|
+
- Workspace: `{{workspace_name}}`
|
|
33
|
+
|
|
34
|
+
## 1. Work Summary
|
|
35
|
+
- Brief narrative of what was completed.
|
|
36
|
+
- Note any deviations from the plan and why.
|
|
37
|
+
|
|
38
|
+
## Checklist
|
|
39
|
+
- [ ] Replace with implementation task item.
|
|
40
|
+
- [ ] Replace with verification checkpoint.
|
|
41
|
+
|
|
42
|
+
## 2. Implementation Steps
|
|
43
|
+
| Step | Description | Status | Evidence / Links |
|
|
44
|
+
| --- | --- | --- | --- |
|
|
45
|
+
| 1 | | pending | |
|
|
46
|
+
|
|
47
|
+
## 3. Testing & Verification
|
|
48
|
+
- Commands executed (summaries only) and outcomes.
|
|
49
|
+
- Coverage of automated and manual checks.
|
|
50
|
+
- Outstanding testing gaps, if any.
|
|
51
|
+
|
|
52
|
+
## 4. Issues & Follow-ups
|
|
53
|
+
- Bugs discovered, blocked tasks, escalations.
|
|
54
|
+
- Required clarifications for future cycles.
|
|
55
|
+
|
|
56
|
+
## 5. Deliverables
|
|
57
|
+
- Key files, PRs, or artifacts delivered.
|
|
58
|
+
- Documentation or knowledge updates triggered.
|
|
59
|
+
|
|
60
|
+
## 6. Next Actions
|
|
61
|
+
- Items remaining before handoff or release.
|
|
62
|
+
- Recommendations for the Documentation agent.
|
|
63
|
+
|
|
64
|
+
> Keep this log under 500 lines. Inline only the essential evidence; link to detailed outputs when needed.
|
|
@@ -0,0 +1,307 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
TEMPLATE: Project Context (Init Output)
|
|
3
|
+
|
|
4
|
+
HOW TO USE:
|
|
5
|
+
1. Copy to: {{CE_DATA}}/knowledge/project-context.md
|
|
6
|
+
2. Replace {{variable}} placeholders with actual values
|
|
7
|
+
3. Delete sections marked (OPTIONAL) if empty after population
|
|
8
|
+
4. Fill in remaining sections with discovered information
|
|
9
|
+
|
|
10
|
+
SYSTEM PATH VARIABLES (Must be replaced by agent using System Resolved Paths):
|
|
11
|
+
- {{WORKSPACE_ROOT}}: Source code directory
|
|
12
|
+
- {{WORKSPACE_NAME}}: Project name
|
|
13
|
+
- {{CE_DATA}}: Storage path for knowledge/tasks (Use value from system context!)
|
|
14
|
+
- {{CE_HOME}}: Global CE-Workflow home directory
|
|
15
|
+
|
|
16
|
+
AGENT-FILLED VARIABLES:
|
|
17
|
+
- {{project_name}}: Name of the project
|
|
18
|
+
- {{date}}: ISO date (YYYY-MM-DD)
|
|
19
|
+
- {{author}}: Git user or agent name
|
|
20
|
+
- {{workspace_root}}: Same as WORKSPACE_ROOT
|
|
21
|
+
|
|
22
|
+
DYNAMIC VARIABLES:
|
|
23
|
+
- {{test_unit_command}}: Command to run unit tests
|
|
24
|
+
- {{test_integration_command}}: Command to run integration tests
|
|
25
|
+
- {{test_e2e_command}}: Command to run e2e tests
|
|
26
|
+
- {{coverage_command}}: Command to generate coverage report
|
|
27
|
+
- {{last_indexed_date}}: Last semantic index update
|
|
28
|
+
- {{index_path}}: Path to embeddings.json
|
|
29
|
+
-->
|
|
30
|
+
# Project Context – {{project_name}}
|
|
31
|
+
|
|
32
|
+
- Initialized: `{{date}}`
|
|
33
|
+
- Last Updated: `{{date}}`
|
|
34
|
+
- Author: `{{author}}`
|
|
35
|
+
- Workspace: `{{workspace_root}}`
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## 1. Project Identity
|
|
40
|
+
|
|
41
|
+
| Attribute | Value |
|
|
42
|
+
|-----------|-------|
|
|
43
|
+
| **Name** | |
|
|
44
|
+
| **Description** | |
|
|
45
|
+
| **Primary Language(s)** | |
|
|
46
|
+
| **Runtime Version(s)** | |
|
|
47
|
+
| **Repository Type** | monorepo / single-app / library |
|
|
48
|
+
| **License** | |
|
|
49
|
+
|
|
50
|
+
### Key Documentation
|
|
51
|
+
- README:
|
|
52
|
+
- CONTRIBUTING:
|
|
53
|
+
- Other:
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## 2. Tech Stack
|
|
58
|
+
|
|
59
|
+
### Languages & Runtimes
|
|
60
|
+
| Language | Version | Purpose |
|
|
61
|
+
|----------|---------|---------|
|
|
62
|
+
| | | |
|
|
63
|
+
|
|
64
|
+
### Frameworks
|
|
65
|
+
| Framework | Version | Layer |
|
|
66
|
+
|-----------|---------|-------|
|
|
67
|
+
| | | frontend / backend / cli / mobile |
|
|
68
|
+
|
|
69
|
+
### Databases & Storage
|
|
70
|
+
| Technology | Purpose |
|
|
71
|
+
|------------|---------|
|
|
72
|
+
| | |
|
|
73
|
+
|
|
74
|
+
### External Services & APIs
|
|
75
|
+
| Service | Purpose | Auth Method |
|
|
76
|
+
|---------|---------|-------------|
|
|
77
|
+
| | | |
|
|
78
|
+
|
|
79
|
+
### Build Tools
|
|
80
|
+
| Tool | Config File | Purpose |
|
|
81
|
+
|------|-------------|---------|
|
|
82
|
+
| | | |
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## 3. Code Organization
|
|
87
|
+
|
|
88
|
+
### Directory Structure
|
|
89
|
+
```
|
|
90
|
+
{{workspace_root}}/
|
|
91
|
+
├──
|
|
92
|
+
├──
|
|
93
|
+
└──
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Structure Pattern
|
|
97
|
+
- [ ] Monorepo (multiple packages/services)
|
|
98
|
+
- [ ] Modular (feature-based organization)
|
|
99
|
+
- [ ] Layered (controllers/services/repositories)
|
|
100
|
+
- [ ] Flat (minimal nesting)
|
|
101
|
+
- [ ] Other:
|
|
102
|
+
|
|
103
|
+
### Key Directories
|
|
104
|
+
| Directory | Purpose |
|
|
105
|
+
|-----------|---------|
|
|
106
|
+
| `src/` | |
|
|
107
|
+
| `tests/` | |
|
|
108
|
+
| `docs/` | |
|
|
109
|
+
|
|
110
|
+
### Entry Points
|
|
111
|
+
| File | Purpose |
|
|
112
|
+
|------|---------|
|
|
113
|
+
| | |
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## 4. Coding Conventions
|
|
118
|
+
|
|
119
|
+
### Style & Formatting
|
|
120
|
+
| Tool | Config File | Key Rules |
|
|
121
|
+
|------|-------------|-----------|
|
|
122
|
+
| Linter | | |
|
|
123
|
+
| Formatter | | |
|
|
124
|
+
| Type Checker | | |
|
|
125
|
+
|
|
126
|
+
### Naming Conventions
|
|
127
|
+
| Element | Convention | Example |
|
|
128
|
+
|---------|------------|---------|
|
|
129
|
+
| Files | | |
|
|
130
|
+
| Functions | | |
|
|
131
|
+
| Classes | | |
|
|
132
|
+
| Variables | | |
|
|
133
|
+
| Constants | | |
|
|
134
|
+
|
|
135
|
+
### Patterns Observed
|
|
136
|
+
- **Error Handling**:
|
|
137
|
+
- **State Management**:
|
|
138
|
+
- **Async Patterns**:
|
|
139
|
+
- **Logging**:
|
|
140
|
+
- **Configuration**:
|
|
141
|
+
- **Code Quality Gates**:
|
|
142
|
+
- [ ] Type checking enforced
|
|
143
|
+
- [ ] Lint checks in CI
|
|
144
|
+
- [ ] Code review required
|
|
145
|
+
- [ ] Commit message conventions
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
## 5. Testing Strategy
|
|
150
|
+
|
|
151
|
+
### Test Frameworks
|
|
152
|
+
| Framework | Purpose | Config |
|
|
153
|
+
|-----------|---------|--------|
|
|
154
|
+
| | unit | |
|
|
155
|
+
| | integration | |
|
|
156
|
+
| | e2e | |
|
|
157
|
+
|
|
158
|
+
### Test Organization
|
|
159
|
+
- [ ] Co-located with source (`*.test.ts` next to `*.ts`)
|
|
160
|
+
- [ ] Separate `tests/` directory
|
|
161
|
+
- [ ] Separate `__tests__/` directories
|
|
162
|
+
- [ ] Other:
|
|
163
|
+
|
|
164
|
+
### Coverage Requirements
|
|
165
|
+
| Metric | Target | Current |
|
|
166
|
+
|--------|--------|---------|
|
|
167
|
+
| Line Coverage | | |
|
|
168
|
+
| Branch Coverage | | |
|
|
169
|
+
|
|
170
|
+
### Test Commands
|
|
171
|
+
```bash
|
|
172
|
+
# Unit tests
|
|
173
|
+
{{test_unit_command}}
|
|
174
|
+
|
|
175
|
+
# Integration tests
|
|
176
|
+
{{test_integration_command}}
|
|
177
|
+
|
|
178
|
+
# E2E tests
|
|
179
|
+
{{test_e2e_command}}
|
|
180
|
+
|
|
181
|
+
# Coverage report
|
|
182
|
+
{{coverage_command}}
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
---
|
|
186
|
+
|
|
187
|
+
## 6. DevOps & Deployment
|
|
188
|
+
|
|
189
|
+
### CI/CD
|
|
190
|
+
| Platform | Config File | Triggers |
|
|
191
|
+
|----------|-------------|----------|
|
|
192
|
+
| | | |
|
|
193
|
+
|
|
194
|
+
### Containerization
|
|
195
|
+
| Tool | Config File | Purpose |
|
|
196
|
+
|------|-------------|---------|
|
|
197
|
+
| Docker | | |
|
|
198
|
+
| Compose | | |
|
|
199
|
+
|
|
200
|
+
### Environments
|
|
201
|
+
| Environment | URL/Access | Notes |
|
|
202
|
+
|-------------|------------|-------|
|
|
203
|
+
| Development | | |
|
|
204
|
+
| Staging | | |
|
|
205
|
+
| Production | | |
|
|
206
|
+
|
|
207
|
+
### Infrastructure
|
|
208
|
+
| Tool | Purpose |
|
|
209
|
+
|------|---------|
|
|
210
|
+
| | |
|
|
211
|
+
|
|
212
|
+
---
|
|
213
|
+
|
|
214
|
+
## 7. Dependencies & Constraints
|
|
215
|
+
|
|
216
|
+
### Key Dependencies
|
|
217
|
+
| Dependency | Version | Purpose | Critical? |
|
|
218
|
+
|------------|---------|---------|-----------|
|
|
219
|
+
| | | | yes/no |
|
|
220
|
+
|
|
221
|
+
### Version Strategy
|
|
222
|
+
- [ ] Exact versions pinned
|
|
223
|
+
- [ ] Semver ranges allowed
|
|
224
|
+
- [ ] Lock file committed
|
|
225
|
+
- [ ] Regular dependency updates
|
|
226
|
+
|
|
227
|
+
### Constraints & Requirements
|
|
228
|
+
- **Node/Runtime Version**:
|
|
229
|
+
- **OS Compatibility**:
|
|
230
|
+
- **Browser Support**:
|
|
231
|
+
- **Security Requirements**:
|
|
232
|
+
- **Performance Targets**:
|
|
233
|
+
|
|
234
|
+
---
|
|
235
|
+
|
|
236
|
+
## 8. Skill Requirements (Executor Scope)
|
|
237
|
+
|
|
238
|
+
Based on the tech stack analysis, the Executor agent should have proficiency in:
|
|
239
|
+
|
|
240
|
+
### Required Skills
|
|
241
|
+
- [ ]
|
|
242
|
+
- [ ]
|
|
243
|
+
- [ ]
|
|
244
|
+
|
|
245
|
+
### Preferred Skills
|
|
246
|
+
- [ ]
|
|
247
|
+
- [ ]
|
|
248
|
+
|
|
249
|
+
### Out of Scope
|
|
250
|
+
-
|
|
251
|
+
-
|
|
252
|
+
|
|
253
|
+
---
|
|
254
|
+
|
|
255
|
+
## 9. Project Scope (Research Boundaries)
|
|
256
|
+
|
|
257
|
+
### In Scope for Research
|
|
258
|
+
-
|
|
259
|
+
-
|
|
260
|
+
|
|
261
|
+
### Out of Scope
|
|
262
|
+
-
|
|
263
|
+
-
|
|
264
|
+
|
|
265
|
+
### Key Stakeholders
|
|
266
|
+
| Role | Responsibility |
|
|
267
|
+
|------|----------------|
|
|
268
|
+
| | |
|
|
269
|
+
|
|
270
|
+
---
|
|
271
|
+
|
|
272
|
+
## 10. Open Questions & Gaps
|
|
273
|
+
|
|
274
|
+
| Question | Priority | Notes |
|
|
275
|
+
|----------|----------|-------|
|
|
276
|
+
| | high/medium/low | |
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
---
|
|
280
|
+
|
|
281
|
+
## 11. Semantic Index Status
|
|
282
|
+
|
|
283
|
+
| Attribute | Value |
|
|
284
|
+
|-----------|-------|
|
|
285
|
+
| **Enabled** | yes / no |
|
|
286
|
+
| **Last Indexed** | `{{last_indexed_date}}` |
|
|
287
|
+
| **Index Location** | `{{index_path}}` |
|
|
288
|
+
| **Total Files** | |
|
|
289
|
+
| **Total Chunks** | |
|
|
290
|
+
|
|
291
|
+
*If semantic search is enabled, run `index_knowledge` to update the index after significant changes.*
|
|
292
|
+
|
|
293
|
+
---
|
|
294
|
+
|
|
295
|
+
## Checklist
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
- [ ] Tech stack fully documented
|
|
299
|
+
- [ ] Coding conventions captured
|
|
300
|
+
- [ ] Testing strategy clear
|
|
301
|
+
- [ ] DevOps pipeline understood
|
|
302
|
+
- [ ] Skill requirements defined
|
|
303
|
+
- [ ] Scope boundaries established
|
|
304
|
+
|
|
305
|
+
---
|
|
306
|
+
|
|
307
|
+
> Keep this document under 500 lines. Update when major changes occur. Run `ce-workflow sync` periodically to reconcile with codebase changes.
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
{
|
|
2
|
+
"task_id": "",
|
|
3
|
+
"task_slug": "",
|
|
4
|
+
"title": "",
|
|
5
|
+
"status": "draft",
|
|
6
|
+
"summary": "",
|
|
7
|
+
"workspace": {
|
|
8
|
+
"name": "",
|
|
9
|
+
"path": "",
|
|
10
|
+
"hash": ""
|
|
11
|
+
},
|
|
12
|
+
"created_at": "",
|
|
13
|
+
"updated_at": "",
|
|
14
|
+
"tags": [],
|
|
15
|
+
"checklist": [
|
|
16
|
+
{
|
|
17
|
+
"id": "",
|
|
18
|
+
"label": "",
|
|
19
|
+
"status": "pending",
|
|
20
|
+
"owner": "",
|
|
21
|
+
"notes": ""
|
|
22
|
+
}
|
|
23
|
+
],
|
|
24
|
+
"references": [],
|
|
25
|
+
"open_questions": [],
|
|
26
|
+
"decisions": [],
|
|
27
|
+
"milestones": [],
|
|
28
|
+
"agents": {
|
|
29
|
+
"research": {
|
|
30
|
+
"owner": "",
|
|
31
|
+
"status": "pending",
|
|
32
|
+
"artifact": "",
|
|
33
|
+
"notes": ""
|
|
34
|
+
},
|
|
35
|
+
"planning": {
|
|
36
|
+
"owner": "",
|
|
37
|
+
"status": "pending",
|
|
38
|
+
"artifact": "",
|
|
39
|
+
"notes": ""
|
|
40
|
+
},
|
|
41
|
+
"executor": {
|
|
42
|
+
"owner": "",
|
|
43
|
+
"status": "pending",
|
|
44
|
+
"artifact": "",
|
|
45
|
+
"notes": ""
|
|
46
|
+
},
|
|
47
|
+
"documentation": {
|
|
48
|
+
"owner": "",
|
|
49
|
+
"status": "pending",
|
|
50
|
+
"artifact": "",
|
|
51
|
+
"notes": ""
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|