@pixelfactoryio/theway 0.0.0-stage → 0.3.1
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/LICENSE +21 -0
- package/README.md +36 -2
- package/dist/theway.js +2674 -0
- package/package.json +33 -4
- package/plugin/.claude-plugin/plugin.json +9 -0
- package/plugin/commands/archive.md +89 -0
- package/plugin/commands/develop-workflow.md +106 -0
- package/plugin/commands/develop.md +38 -0
- package/plugin/commands/document.md +58 -0
- package/plugin/commands/engineering.md +84 -0
- package/plugin/commands/list.md +24 -0
- package/plugin/commands/setup.md +25 -0
- package/plugin/templates/theway/AGENTS.md +170 -0
- package/plugin/templates/theway/CLAUDE.md +17 -0
- package/plugin/templates/theway/changes/archive/.gitkeep +0 -0
- package/plugin/templates/theway/config.yaml +90 -0
- package/plugin/templates/theway/data/standards/architecture-principles.md +50 -0
- package/plugin/templates/theway/data/standards/develop.md +28 -0
- package/plugin/templates/theway/data/standards/interaction.md +13 -0
- package/plugin/templates/theway/data/standards/tamm-framework.md +82 -0
- package/plugin/templates/theway/project.md +31 -0
- package/plugin/templates/theway/templates/coding-standards-template.md +102 -0
- package/plugin/templates/theway/templates/source-tree-template.md +129 -0
- package/plugin/templates/theway/templates/spec-template.md +114 -0
- package/plugin/templates/theway/templates/tasks-template.md +86 -0
- package/plugin/templates/theway/templates/tech-stack-template.md +159 -0
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
---
|
|
2
|
+
template_type: "implementation_tasks"
|
|
3
|
+
usage: "Create numbered implementation checklist when scaffolding a change with /theway:engineering"
|
|
4
|
+
agent_role: "Full-stack developer who breaks down spec analysis into concrete, sequential implementation tasks"
|
|
5
|
+
required_context:
|
|
6
|
+
- "<change-dir>/spec.md - Understand solution, scope, and hardpoints"
|
|
7
|
+
- "<home>/config.yaml - Global config and conventions"
|
|
8
|
+
- "docs/architecture/coding-standards.md - Project coding standards (if exists)"
|
|
9
|
+
quality_standards:
|
|
10
|
+
- "Tasks are numbered sequentially for easy tracking"
|
|
11
|
+
- "Each task has a checkbox [ ] for progress tracking"
|
|
12
|
+
- "Tasks are organized by logical implementation phases"
|
|
13
|
+
- "Tasks are specific and actionable (not vague)"
|
|
14
|
+
- "Estimated time provided for each phase"
|
|
15
|
+
- "Notes section captures blockers, discoveries, and adjustments"
|
|
16
|
+
- "Tasks are only work done in the repository: no tasks for reviewing the spec, setting up the environment, branching, PRs, code review, merging or archiving (the commands do those)"
|
|
17
|
+
workflow_steps:
|
|
18
|
+
- "1. Review spec analysis to understand solution and phases"
|
|
19
|
+
- "2. Break each phase into specific, sequential tasks"
|
|
20
|
+
- "3. Number all tasks consecutively across phases"
|
|
21
|
+
- "4. Estimate time for each phase realistically"
|
|
22
|
+
- "5. Include testing and documentation tasks"
|
|
23
|
+
best_practices:
|
|
24
|
+
- "Work sequentially through tasks in order"
|
|
25
|
+
- "Check off tasks immediately after completion"
|
|
26
|
+
- "Update Notes section as you discover new information"
|
|
27
|
+
- "Add new tasks inline if discovered during implementation"
|
|
28
|
+
- "Keep task descriptions concise but clear"
|
|
29
|
+
- "Ensure every spec phase has corresponding tasks"
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
# Implementation Tasks: [Change Name]
|
|
33
|
+
|
|
34
|
+
## Overview
|
|
35
|
+
|
|
36
|
+
**Total Estimated Effort:** [Time estimate]
|
|
37
|
+
**Target Completion:** [Date]
|
|
38
|
+
|
|
39
|
+
## Phase 1: [Core Implementation Phase Name]
|
|
40
|
+
|
|
41
|
+
**Estimated Time:** [Duration]
|
|
42
|
+
|
|
43
|
+
- [ ] 1. [Specific implementation task]
|
|
44
|
+
- [ ] 2. [Specific implementation task]
|
|
45
|
+
- [ ] 3. [Specific implementation task]
|
|
46
|
+
- [ ] 4. [Specific implementation task]
|
|
47
|
+
- [ ] 5. [Specific implementation task]
|
|
48
|
+
|
|
49
|
+
## Phase 2: [Secondary Implementation Phase Name]
|
|
50
|
+
|
|
51
|
+
**Estimated Time:** [Duration]
|
|
52
|
+
|
|
53
|
+
- [ ] 6. [Specific implementation task]
|
|
54
|
+
- [ ] 7. [Specific implementation task]
|
|
55
|
+
- [ ] 8. [Specific implementation task]
|
|
56
|
+
- [ ] 9. [Specific implementation task]
|
|
57
|
+
|
|
58
|
+
## Phase 3: Testing
|
|
59
|
+
|
|
60
|
+
**Estimated Time:** [Duration]
|
|
61
|
+
|
|
62
|
+
- [ ] 10. Write unit tests for [component]
|
|
63
|
+
- [ ] 11. Write integration tests for [flow]
|
|
64
|
+
- [ ] 12. Add end-to-end tests for [scenario]
|
|
65
|
+
- [ ] 13. Test error scenarios and edge cases
|
|
66
|
+
- [ ] 14. Verify performance requirements
|
|
67
|
+
- [ ] 15. Manual testing and validation
|
|
68
|
+
|
|
69
|
+
## Phase 4: Documentation
|
|
70
|
+
|
|
71
|
+
**Estimated Time:** [Duration]
|
|
72
|
+
|
|
73
|
+
- [ ] 16. Update API documentation
|
|
74
|
+
- [ ] 17. Update architecture docs (if needed)
|
|
75
|
+
- [ ] 18. Update README/user docs
|
|
76
|
+
|
|
77
|
+
## Notes
|
|
78
|
+
|
|
79
|
+
**Blockers:**
|
|
80
|
+
- [List any blocking issues as they arise]
|
|
81
|
+
|
|
82
|
+
**Discoveries:**
|
|
83
|
+
- [Document any findings that affect the plan]
|
|
84
|
+
|
|
85
|
+
**Adjustments:**
|
|
86
|
+
- [Note any changes to the original plan]
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
---
|
|
2
|
+
template_type: "tech_stack"
|
|
3
|
+
usage: "Document technology choices, dependencies, and rationale when using /theway:document to fill documentation gaps"
|
|
4
|
+
agent_role: "System Architect documenting technology stack decisions following SRE-EE principles"
|
|
5
|
+
required_context:
|
|
6
|
+
- "<home>/config.yaml - Global config and conventions"
|
|
7
|
+
- "<home>/data/standards/architecture-principles.md - SRE-EE principles (if enabled)"
|
|
8
|
+
- "Package files (package.json, requirements.txt, go.mod, etc.) - Actual dependencies"
|
|
9
|
+
- "Infrastructure configs (terraform, k8s manifests) - Deployment tech"
|
|
10
|
+
quality_standards:
|
|
11
|
+
- "Technology stack table includes version, purpose, and rationale"
|
|
12
|
+
- "Core dependencies list is accurate from package files"
|
|
13
|
+
- "Technical decisions explain trade-offs and alternatives considered"
|
|
14
|
+
- "Infrastructure and deployment tools are documented"
|
|
15
|
+
- "Version constraints reflect actual compatibility requirements"
|
|
16
|
+
- "Migration notes capture historical context"
|
|
17
|
+
- "Rationales explain WHY choices were made, not just WHAT"
|
|
18
|
+
workflow_steps:
|
|
19
|
+
- "1. Review package files to identify all dependencies"
|
|
20
|
+
- "2. Document cloud provider and key services in use"
|
|
21
|
+
- "3. Create technology stack table with versions and rationales"
|
|
22
|
+
- "4. List core dependencies with their purposes"
|
|
23
|
+
- "5. Document development tools and infrastructure setup"
|
|
24
|
+
- "6. Capture technical decisions with trade-offs"
|
|
25
|
+
- "7. Add version constraints and update policies"
|
|
26
|
+
best_practices:
|
|
27
|
+
- "Document actual versions in use, not aspirational ones"
|
|
28
|
+
- "Explain WHY each technology was chosen (trade-offs, alternatives)"
|
|
29
|
+
- "Include migration notes for historical context"
|
|
30
|
+
- "Update when major dependencies change"
|
|
31
|
+
- "Reference ADRs (Architecture Decision Records) if they exist"
|
|
32
|
+
- "Keep rationales concise but informative"
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
# Tech Stack
|
|
36
|
+
|
|
37
|
+
## Overview
|
|
38
|
+
|
|
39
|
+
Technology choices, dependencies, and rationale for {{PROJECT_NAME}}.
|
|
40
|
+
|
|
41
|
+
## Cloud Infrastructure
|
|
42
|
+
|
|
43
|
+
- **Provider:** {{CLOUD_PROVIDER}}
|
|
44
|
+
- **Key Services:** {{CORE_SERVICES}}
|
|
45
|
+
- **Deployment Regions:** {{REGIONS}}
|
|
46
|
+
|
|
47
|
+
## Technology Stack
|
|
48
|
+
|
|
49
|
+
| Category | Technology | Version | Purpose | Rationale |
|
|
50
|
+
|----------|------------|---------|---------|-----------|
|
|
51
|
+
| **Language** | {{LANGUAGE}} | {{VERSION}} | {{PURPOSE}} | {{RATIONALE}} |
|
|
52
|
+
| **Framework** | {{FRAMEWORK}} | {{VERSION}} | {{PURPOSE}} | {{RATIONALE}} |
|
|
53
|
+
| **Database** | {{DATABASE}} | {{VERSION}} | {{PURPOSE}} | {{RATIONALE}} |
|
|
54
|
+
| **Cache** | {{CACHE}} | {{VERSION}} | {{PURPOSE}} | {{RATIONALE}} |
|
|
55
|
+
| **Message Queue** | {{QUEUE}} | {{VERSION}} | {{PURPOSE}} | {{RATIONALE}} |
|
|
56
|
+
| **Build Tool** | {{BUILD_TOOL}} | {{VERSION}} | {{PURPOSE}} | {{RATIONALE}} |
|
|
57
|
+
| **IaC** | {{IAC_TOOL}} | {{VERSION}} | {{PURPOSE}} | {{RATIONALE}} |
|
|
58
|
+
| **Monitoring** | {{MONITORING}} | {{VERSION}} | {{PURPOSE}} | {{RATIONALE}} |
|
|
59
|
+
| **Logging** | {{LOGGING}} | {{VERSION}} | {{PURPOSE}} | {{RATIONALE}} |
|
|
60
|
+
|
|
61
|
+
## Core Dependencies
|
|
62
|
+
|
|
63
|
+
### {{LANGUAGE}} Dependencies
|
|
64
|
+
|
|
65
|
+
```{{PACKAGE_FILE_FORMAT}}
|
|
66
|
+
{{DEPENDENCY_1}} = "{{VERSION}}" # {{PURPOSE}}
|
|
67
|
+
{{DEPENDENCY_2}} = "{{VERSION}}" # {{PURPOSE}}
|
|
68
|
+
{{DEPENDENCY_3}} = "{{VERSION}}" # {{PURPOSE}}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
**Key Libraries:**
|
|
72
|
+
- **{{LIBRARY_1}}** ({{VERSION}}) - {{LIBRARY_1_PURPOSE}}
|
|
73
|
+
- **{{LIBRARY_2}}** ({{VERSION}}) - {{LIBRARY_2_PURPOSE}}
|
|
74
|
+
- **{{LIBRARY_3}}** ({{VERSION}}) - {{LIBRARY_3_PURPOSE}}
|
|
75
|
+
|
|
76
|
+
## Development Tools
|
|
77
|
+
|
|
78
|
+
- **IDE:** {{IDE_RECOMMENDATION}}
|
|
79
|
+
- **Linter:** {{LINTER}} {{VERSION}}
|
|
80
|
+
- **Formatter:** {{FORMATTER}} {{VERSION}}
|
|
81
|
+
- **Test Runner:** {{TEST_RUNNER}} {{VERSION}}
|
|
82
|
+
- **Local Development:** {{LOCAL_DEV_TOOLS}}
|
|
83
|
+
|
|
84
|
+
## Infrastructure & Deployment
|
|
85
|
+
|
|
86
|
+
### Deployment Tools
|
|
87
|
+
- **Container Runtime:** {{CONTAINER_RUNTIME}} {{VERSION}}
|
|
88
|
+
- **Orchestration:** {{ORCHESTRATION}} {{VERSION}}
|
|
89
|
+
- **CI/CD:** {{CICD_PLATFORM}}
|
|
90
|
+
|
|
91
|
+
### Infrastructure as Code
|
|
92
|
+
- **Tool:** {{IAC_TOOL}} {{VERSION}}
|
|
93
|
+
- **State Management:** {{STATE_MANAGEMENT}}
|
|
94
|
+
- **Module Structure:** {{MODULE_STRUCTURE}}
|
|
95
|
+
|
|
96
|
+
## Database & Storage
|
|
97
|
+
|
|
98
|
+
### Primary Database
|
|
99
|
+
- **Type:** {{DB_TYPE}}
|
|
100
|
+
- **Technology:** {{DB_TECH}} {{VERSION}}
|
|
101
|
+
- **Driver:** {{DB_DRIVER}} {{VERSION}}
|
|
102
|
+
- **Migration Tool:** {{MIGRATION_TOOL}}
|
|
103
|
+
|
|
104
|
+
### Storage Solutions
|
|
105
|
+
- **Object Storage:** {{OBJECT_STORAGE}}
|
|
106
|
+
- **File Storage:** {{FILE_STORAGE}}
|
|
107
|
+
- **Cache:** {{CACHE_SOLUTION}} {{VERSION}}
|
|
108
|
+
|
|
109
|
+
## Monitoring & Observability
|
|
110
|
+
|
|
111
|
+
- **Metrics:** {{METRICS_PLATFORM}}
|
|
112
|
+
- **Logging:** {{LOGGING_PLATFORM}}
|
|
113
|
+
- **Tracing:** {{TRACING_PLATFORM}}
|
|
114
|
+
- **Alerting:** {{ALERTING_PLATFORM}}
|
|
115
|
+
|
|
116
|
+
## Security Tools
|
|
117
|
+
|
|
118
|
+
- **Secrets Management:** {{SECRETS_TOOL}}
|
|
119
|
+
- **Authentication:** {{AUTH_METHOD}}
|
|
120
|
+
- **Authorization:** {{AUTHZ_METHOD}}
|
|
121
|
+
- **Security Scanning:** {{SECURITY_SCANNER}}
|
|
122
|
+
|
|
123
|
+
## Version Constraints
|
|
124
|
+
|
|
125
|
+
### Compatibility Requirements
|
|
126
|
+
- {{CONSTRAINT_1}}
|
|
127
|
+
- {{CONSTRAINT_2}}
|
|
128
|
+
- {{CONSTRAINT_3}}
|
|
129
|
+
|
|
130
|
+
### Update Policy
|
|
131
|
+
- **Major Versions:** {{MAJOR_VERSION_POLICY}}
|
|
132
|
+
- **Minor Versions:** {{MINOR_VERSION_POLICY}}
|
|
133
|
+
- **Patch Versions:** {{PATCH_VERSION_POLICY}}
|
|
134
|
+
- **Security Updates:** {{SECURITY_UPDATE_POLICY}}
|
|
135
|
+
|
|
136
|
+
## Technical Decisions
|
|
137
|
+
|
|
138
|
+
### {{DECISION_TOPIC_1}}
|
|
139
|
+
**Decision:** {{DECISION_1}}
|
|
140
|
+
**Rationale:** {{RATIONALE_1}}
|
|
141
|
+
**Trade-offs:** {{TRADEOFFS_1}}
|
|
142
|
+
|
|
143
|
+
### {{DECISION_TOPIC_2}}
|
|
144
|
+
**Decision:** {{DECISION_2}}
|
|
145
|
+
**Rationale:** {{RATIONALE_2}}
|
|
146
|
+
**Trade-offs:** {{TRADEOFFS_2}}
|
|
147
|
+
|
|
148
|
+
### {{DECISION_TOPIC_3}}
|
|
149
|
+
**Decision:** {{DECISION_3}}
|
|
150
|
+
**Rationale:** {{RATIONALE_3}}
|
|
151
|
+
**Trade-offs:** {{TRADEOFFS_3}}
|
|
152
|
+
|
|
153
|
+
## Migration Notes
|
|
154
|
+
|
|
155
|
+
{{MIGRATION_NOTES}}
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
**Last Updated:** {{DATE}}
|