context-first-cli 2.1.5 → 2.2.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/dist/templates/commands/en/engineer/plan.md +48 -10
- package/dist/templates/commands/en/engineer/pr.md +73 -12
- package/dist/templates/commands/en/engineer/pre-pr.md +69 -8
- package/dist/templates/commands/en/engineer/start.md +60 -23
- package/dist/templates/commands/en/engineer/work.md +45 -7
- package/dist/templates/commands/en/products/check.md +48 -11
- package/dist/templates/commands/en/products/collect.md +51 -14
- package/dist/templates/commands/es/engineer/plan.md +60 -22
- package/dist/templates/commands/es/engineer/pr.md +71 -10
- package/dist/templates/commands/es/engineer/pre-pr.md +90 -29
- package/dist/templates/commands/es/engineer/start.md +52 -15
- package/dist/templates/commands/es/engineer/work.md +91 -53
- package/dist/templates/commands/es/products/check.md +48 -10
- package/dist/templates/commands/es/products/collect.md +55 -18
- package/dist/templates/commands/pt-BR/engineer/plan.md +38 -0
- package/dist/templates/commands/pt-BR/engineer/pr.md +61 -0
- package/dist/templates/commands/pt-BR/engineer/pre-pr.md +61 -0
- package/dist/templates/commands/pt-BR/engineer/start.md +38 -0
- package/dist/templates/commands/pt-BR/engineer/work.md +38 -0
- package/dist/templates/commands/pt-BR/products/check.md +38 -0
- package/dist/templates/commands/pt-BR/products/collect.md +38 -0
- package/dist/templates/commands/pt-BR/products/refine.md +38 -0
- package/dist/templates/commands/pt-BR/products/spec.md +38 -0
- package/dist/templates/commands/pt-BR/quality/metrics.md +38 -0
- package/dist/templates/commands/pt-BR/quality/observe.md +38 -0
- package/dist/templates/commands/pt-BR/warm-up.md +38 -0
- package/package.json +1 -1
- package/templates/commands/en/engineer/plan.md +48 -10
- package/templates/commands/en/engineer/pr.md +73 -12
- package/templates/commands/en/engineer/pre-pr.md +69 -8
- package/templates/commands/en/engineer/start.md +60 -23
- package/templates/commands/en/engineer/work.md +45 -7
- package/templates/commands/en/products/check.md +48 -11
- package/templates/commands/en/products/collect.md +51 -14
- package/templates/commands/es/engineer/plan.md +60 -22
- package/templates/commands/es/engineer/pr.md +71 -10
- package/templates/commands/es/engineer/pre-pr.md +90 -29
- package/templates/commands/es/engineer/start.md +52 -15
- package/templates/commands/es/engineer/work.md +91 -53
- package/templates/commands/es/products/check.md +48 -10
- package/templates/commands/es/products/collect.md +55 -18
- package/templates/commands/pt-BR/engineer/plan.md +38 -0
- package/templates/commands/pt-BR/engineer/pr.md +61 -0
- package/templates/commands/pt-BR/engineer/pre-pr.md +61 -0
- package/templates/commands/pt-BR/engineer/start.md +38 -0
- package/templates/commands/pt-BR/engineer/work.md +38 -0
- package/templates/commands/pt-BR/products/check.md +38 -0
- package/templates/commands/pt-BR/products/collect.md +38 -0
- package/templates/commands/pt-BR/products/refine.md +38 -0
- package/templates/commands/pt-BR/products/spec.md +38 -0
- package/templates/commands/pt-BR/quality/metrics.md +38 -0
- package/templates/commands/pt-BR/quality/observe.md +38 -0
- package/templates/commands/pt-BR/warm-up.md +38 -0
|
@@ -1,12 +1,50 @@
|
|
|
1
1
|
# Technical Planning
|
|
2
2
|
|
|
3
|
-
This command creates the detailed technical plan for feature implementation.
|
|
3
|
+
This command creates the detailed technical plan for the feature implementation.
|
|
4
4
|
|
|
5
5
|
## 📋 Prerequisites
|
|
6
6
|
|
|
7
7
|
- PRD created via `/spec`
|
|
8
8
|
- Initial analysis done via `/start`
|
|
9
|
-
-
|
|
9
|
+
- `context.md` and `architecture.md` files created and approved
|
|
10
|
+
|
|
11
|
+
## 📋 Project Setup
|
|
12
|
+
|
|
13
|
+
**⚠️ IMPORTANT: Always read the project configuration files BEFORE running this command!**
|
|
14
|
+
|
|
15
|
+
### Mandatory Files
|
|
16
|
+
|
|
17
|
+
1. **`context-manifest.json`** (orchestrator root)
|
|
18
|
+
- List of project repositories
|
|
19
|
+
- Roles of each repository (metaspecs, application, etc.)
|
|
20
|
+
- URLs and dependencies between repositories
|
|
21
|
+
|
|
22
|
+
2. **`ai.properties.md`** (orchestrator root)
|
|
23
|
+
- Project settings (`project_name`, `base_path`)
|
|
24
|
+
- Task management system (`task_management_system`)
|
|
25
|
+
- Credentials and specific configurations
|
|
26
|
+
|
|
27
|
+
### How to Read
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
# 1. Read context-manifest.json
|
|
31
|
+
cat context-manifest.json
|
|
32
|
+
|
|
33
|
+
# 2. Read ai.properties.md
|
|
34
|
+
cat ai.properties.md
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Essential Information
|
|
38
|
+
|
|
39
|
+
After reading the files, you will have:
|
|
40
|
+
- ✅ Complete list of project repositories
|
|
41
|
+
- ✅ Location of the metaspecs repository
|
|
42
|
+
- ✅ Base path to locate repositories
|
|
43
|
+
- ✅ Configured task management system
|
|
44
|
+
- ✅ Project-specific configurations
|
|
45
|
+
|
|
46
|
+
**🛑 DO NOT proceed without reading these files!** They contain critical information for the correct execution of the command.
|
|
47
|
+
|
|
10
48
|
|
|
11
49
|
## 📍 IMPORTANT: Understand the Structure
|
|
12
50
|
|
|
@@ -46,17 +84,17 @@ This command creates the detailed technical plan for feature implementation.
|
|
|
46
84
|
**Automatically locate MetaSpecs**:
|
|
47
85
|
1. Read `context-manifest.json` from the orchestrator
|
|
48
86
|
2. Find the repository with `"role": "metaspecs"`
|
|
49
|
-
3. Read `ai.properties.md` to
|
|
50
|
-
4. The metaspecs are
|
|
87
|
+
3. Read `ai.properties.md` to get the `base_path`
|
|
88
|
+
4. The metaspecs are at: `{base_path}/{metaspecs-repo-id}/`
|
|
51
89
|
5. Read the relevant `index.md` files to ensure compliance with:
|
|
52
90
|
- System architecture
|
|
53
|
-
- Design and code
|
|
91
|
+
- Design and code patterns
|
|
54
92
|
- Folder and file structure
|
|
55
93
|
- Naming conventions
|
|
56
94
|
|
|
57
|
-
## 🎯
|
|
95
|
+
## 🎯 Goal
|
|
58
96
|
|
|
59
|
-
Create a detailed technical plan that will guide the implementation,
|
|
97
|
+
Create a detailed technical plan that will guide the implementation, dividing the work into smaller, sequential units.
|
|
60
98
|
|
|
61
99
|
## 📝 Plan Structure
|
|
62
100
|
|
|
@@ -113,13 +151,13 @@ Create a detailed technical plan that will guide the implementation, breaking th
|
|
|
113
151
|
|
|
114
152
|
### 4. Implementation Plan
|
|
115
153
|
|
|
116
|
-
|
|
154
|
+
Divide the work into small, sequential units:
|
|
117
155
|
|
|
118
156
|
```markdown
|
|
119
157
|
## Implementation Plan
|
|
120
158
|
|
|
121
159
|
### Phase 1: [Phase Name]
|
|
122
|
-
**
|
|
160
|
+
**Goal**: [What will be achieved in this phase]
|
|
123
161
|
**Repositories**: [affected repos]
|
|
124
162
|
|
|
125
163
|
#### Task 1.1: [Description]
|
|
@@ -265,7 +303,7 @@ src/
|
|
|
265
303
|
|
|
266
304
|
## 📄 Saving the Plan
|
|
267
305
|
|
|
268
|
-
Save in `./.sessions/<ISSUE-ID>/plan.md`
|
|
306
|
+
Save it in `./.sessions/<ISSUE-ID>/plan.md`
|
|
269
307
|
|
|
270
308
|
## 🔍 Review
|
|
271
309
|
|
|
@@ -10,32 +10,93 @@ Before creating PRs, make sure that:
|
|
|
10
10
|
- All tests are passing
|
|
11
11
|
- Documentation is up to date
|
|
12
12
|
|
|
13
|
+
## 📋 Project Configuration
|
|
14
|
+
|
|
15
|
+
**⚠️ IMPORTANT: Always read the project configuration files BEFORE running this command!**
|
|
16
|
+
|
|
17
|
+
### Required Files
|
|
18
|
+
|
|
19
|
+
1. **`context-manifest.json`** (root of the orchestrator)
|
|
20
|
+
- List of project repositories
|
|
21
|
+
- Roles of each repository (metaspecs, application, etc.)
|
|
22
|
+
- URLs and dependencies between repositories
|
|
23
|
+
|
|
24
|
+
2. **`ai.properties.md`** (root of the orchestrator)
|
|
25
|
+
- Project settings (`project_name`, `base_path`)
|
|
26
|
+
- Task management system (`task_management_system`)
|
|
27
|
+
- Credentials and specific configurations
|
|
28
|
+
|
|
29
|
+
### How to Read
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
# 1. Read context-manifest.json
|
|
33
|
+
cat context-manifest.json
|
|
34
|
+
|
|
35
|
+
# 2. Read ai.properties.md
|
|
36
|
+
cat ai.properties.md
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Essential Information
|
|
40
|
+
|
|
41
|
+
After reading the files, you will have:
|
|
42
|
+
- ✅ Complete list of project repositories
|
|
43
|
+
- ✅ Location of the metaspecs repository
|
|
44
|
+
- ✅ Base path to locate repositories
|
|
45
|
+
- ✅ Configured task management system
|
|
46
|
+
- ✅ Specific project configurations
|
|
47
|
+
|
|
48
|
+
**🛑 DO NOT proceed without reading these files!** They contain critical information for the correct execution of the command.
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
## 🛑 CRITICAL: WHERE TO WORK
|
|
52
|
+
|
|
53
|
+
**⚠️ ATTENTION: If you need to make last-minute adjustments, ALL CODE MUST BE CREATED INSIDE THE WORKTREE!**
|
|
54
|
+
|
|
55
|
+
**✅ CORRECT** - Work inside the worktree:
|
|
56
|
+
```
|
|
57
|
+
<orchestrator>/.sessions/<ISSUE-ID>/<repo-name>/src/file.ts ✅
|
|
58
|
+
<orchestrator>/.sessions/<ISSUE-ID>/<repo-name>/README.md ✅
|
|
59
|
+
<orchestrator>/.sessions/<ISSUE-ID>/<repo-name>/CHANGELOG.md ✅
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
**❌ WRONG** - NEVER create code outside the worktree:
|
|
63
|
+
```
|
|
64
|
+
<orchestrator>/.sessions/file.ts ❌
|
|
65
|
+
<orchestrator>/.sessions/<ISSUE-ID>/file.ts ❌
|
|
66
|
+
{base_path}/<repo-name>/file.ts ❌ (main repository!)
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
**ABSOLUTE RULE**:
|
|
70
|
+
- 🛑 **Any code adjustment** (docs, changelog, fixes) **MUST be in** `<orchestrator>/.sessions/<ISSUE-ID>/<repo-name>/`
|
|
71
|
+
- 🛑 **NEVER modify** the main repository at `{base_path}/<repo-name>/`
|
|
72
|
+
- ✅ **Work ONLY** inside the worktree of the specific repository
|
|
73
|
+
|
|
13
74
|
## 🎯 PR Creation Process
|
|
14
75
|
|
|
15
76
|
### 1. Identify Modified Repositories
|
|
16
77
|
|
|
17
78
|
For each repository in the workspace, check:
|
|
18
79
|
```bash
|
|
19
|
-
cd <
|
|
80
|
+
cd <repository>
|
|
20
81
|
git status
|
|
21
|
-
git log origin/main..HEAD #
|
|
82
|
+
git log origin/main..HEAD # See unpushed commits
|
|
22
83
|
```
|
|
23
84
|
|
|
24
85
|
### 2. Push Branches
|
|
25
86
|
|
|
26
87
|
For each modified repository:
|
|
27
88
|
```bash
|
|
28
|
-
cd <
|
|
89
|
+
cd <repository>
|
|
29
90
|
git push origin <branch-name>
|
|
30
91
|
```
|
|
31
92
|
|
|
32
93
|
### 3. Create Pull Requests
|
|
33
94
|
|
|
34
|
-
For each repository, create a PR using GitHub CLI or
|
|
95
|
+
For each repository, create a PR using GitHub CLI or web interface:
|
|
35
96
|
|
|
36
97
|
**Using GitHub CLI**:
|
|
37
98
|
```bash
|
|
38
|
-
cd <
|
|
99
|
+
cd <repository>
|
|
39
100
|
gh pr create --title "[ISSUE-ID] Feature Title" \
|
|
40
101
|
--body "$(cat ../.sessions/<ISSUE-ID>/pr-description.md)" \
|
|
41
102
|
--base main
|
|
@@ -50,7 +111,7 @@ gh pr create --title "[ISSUE-ID] Feature Title" \
|
|
|
50
111
|
|
|
51
112
|
## 📝 Changes
|
|
52
113
|
|
|
53
|
-
### Repository: <
|
|
114
|
+
### Repository: <repo-name>
|
|
54
115
|
|
|
55
116
|
- [Change 1]
|
|
56
117
|
- [Change 2]
|
|
@@ -91,15 +152,15 @@ gh pr create --title "[ISSUE-ID] Feature Title" \
|
|
|
91
152
|
### 4. Link PRs
|
|
92
153
|
|
|
93
154
|
If there are multiple PRs (one per repository):
|
|
94
|
-
- Add cross-links between
|
|
155
|
+
- Add cross-links between PRs
|
|
95
156
|
- Document the recommended merge order
|
|
96
157
|
- Indicate dependencies between PRs
|
|
97
158
|
|
|
98
159
|
### 5. Update Issue in Task Manager
|
|
99
160
|
|
|
100
|
-
If
|
|
161
|
+
If task manager is configured:
|
|
101
162
|
- Move the issue to "In Review" or "PR Open"
|
|
102
|
-
- Add PR links
|
|
163
|
+
- Add PR links to the issue
|
|
103
164
|
- Add a comment summarizing the changes
|
|
104
165
|
|
|
105
166
|
### 6. Session Documentation
|
|
@@ -140,13 +201,13 @@ Before requesting review:
|
|
|
140
201
|
- [ ] PRs linked to each other
|
|
141
202
|
- [ ] Issue updated in task manager
|
|
142
203
|
- [ ] Tests passing in CI/CD
|
|
143
|
-
- [ ]
|
|
204
|
+
- [ ] Complete session documentation
|
|
144
205
|
|
|
145
206
|
## 📢 Communication
|
|
146
207
|
|
|
147
208
|
Notify the team about the PRs:
|
|
148
209
|
- Mention relevant reviewers
|
|
149
|
-
- Highlight critical
|
|
210
|
+
- Highlight critical or breaking changes
|
|
150
211
|
- Indicate urgency if applicable
|
|
151
212
|
|
|
152
213
|
---
|
|
@@ -161,7 +222,7 @@ Notify the team about the PRs:
|
|
|
161
222
|
|
|
162
223
|
## 🎯 Next Steps
|
|
163
224
|
|
|
164
|
-
1. Await PR
|
|
225
|
+
1. Await PR reviews
|
|
165
226
|
2. Respond to comments and make adjustments
|
|
166
227
|
3. After approval, merge in the recommended order
|
|
167
228
|
4. Run `context-cli feature:end <ISSUE-ID>` to clean the workspace
|
|
@@ -4,13 +4,74 @@ This command validates that everything is ready to create Pull Requests.
|
|
|
4
4
|
|
|
5
5
|
## 📋 Prerequisites
|
|
6
6
|
|
|
7
|
-
- Complete implementation (all `/plan`
|
|
7
|
+
- Complete implementation (all tasks from `/plan` executed)
|
|
8
8
|
- All commits made
|
|
9
9
|
- Clean and organized workspace
|
|
10
10
|
|
|
11
|
+
## 📋 Project Configuration
|
|
12
|
+
|
|
13
|
+
**⚠️ IMPORTANT: Always read the project configuration files BEFORE running this command!**
|
|
14
|
+
|
|
15
|
+
### Required Files
|
|
16
|
+
|
|
17
|
+
1. **`context-manifest.json`** (orchestrator root)
|
|
18
|
+
- List of project repositories
|
|
19
|
+
- Roles of each repository (metaspecs, application, etc.)
|
|
20
|
+
- URLs and dependencies between repositories
|
|
21
|
+
|
|
22
|
+
2. **`ai.properties.md`** (orchestrator root)
|
|
23
|
+
- Project settings (`project_name`, `base_path`)
|
|
24
|
+
- Task management system (`task_management_system`)
|
|
25
|
+
- Credentials and specific configurations
|
|
26
|
+
|
|
27
|
+
### How to Read
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
# 1. Read context-manifest.json
|
|
31
|
+
cat context-manifest.json
|
|
32
|
+
|
|
33
|
+
# 2. Read ai.properties.md
|
|
34
|
+
cat ai.properties.md
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Essential Information
|
|
38
|
+
|
|
39
|
+
After reading the files, you will have:
|
|
40
|
+
- ✅ Complete list of project repositories
|
|
41
|
+
- ✅ Location of the metaspecs repository
|
|
42
|
+
- ✅ Base path to locate repositories
|
|
43
|
+
- ✅ Configured task management system
|
|
44
|
+
- ✅ Project-specific configurations
|
|
45
|
+
|
|
46
|
+
**🛑 DO NOT proceed without reading these files!** They contain critical information for the correct execution of the command.
|
|
47
|
+
|
|
48
|
+
|
|
11
49
|
## 🎯 Objective
|
|
12
50
|
|
|
13
|
-
Ensure that the implementation is complete, tested, and ready for review before creating
|
|
51
|
+
Ensure that the implementation is complete, tested, and ready for review before creating PRs.
|
|
52
|
+
|
|
53
|
+
## 🛑 CRITICAL: WHERE TO WORK
|
|
54
|
+
|
|
55
|
+
**⚠️ ATTENTION: ALL CODE (tests, fixes, adjustments) MUST BE CREATED INSIDE THE WORKTREE!**
|
|
56
|
+
|
|
57
|
+
**✅ CORRECT** - Work inside the worktree:
|
|
58
|
+
```
|
|
59
|
+
<orchestrator>/.sessions/<ISSUE-ID>/<repo-name>/src/file.ts ✅
|
|
60
|
+
<orchestrator>/.sessions/<ISSUE-ID>/<repo-name>/tests/test.ts ✅
|
|
61
|
+
<orchestrator>/.sessions/<ISSUE-ID>/<repo-name>/.eslintrc.js ✅
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
**❌ WRONG** - NEVER create code outside the worktree:
|
|
65
|
+
```
|
|
66
|
+
<orchestrator>/.sessions/test.ts ❌
|
|
67
|
+
<orchestrator>/.sessions/<ISSUE-ID>/test.ts ❌
|
|
68
|
+
{base_path}/<repo-name>/test.ts ❌ (main repository!)
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
**ABSOLUTE RULE**:
|
|
72
|
+
- 🛑 **ALL code** (tests, fixes, configurations) **MUST be in** `<orchestrator>/.sessions/<ISSUE-ID>/<repo-name>/`
|
|
73
|
+
- 🛑 **NEVER modify** the main repository in `{base_path}/<repo-name>/`
|
|
74
|
+
- ✅ **Work ONLY** inside the worktree of the specific repository
|
|
14
75
|
|
|
15
76
|
## ✅ Validation Checklist
|
|
16
77
|
|
|
@@ -22,7 +83,7 @@ Ensure that the implementation is complete, tested, and ready for review before
|
|
|
22
83
|
- [ ] All plan tasks have been executed
|
|
23
84
|
- [ ] All functional requirements from the PRD have been implemented
|
|
24
85
|
- [ ] All acceptance criteria have been met
|
|
25
|
-
- [ ] No functionality is
|
|
86
|
+
- [ ] No functionality is half-done
|
|
26
87
|
```
|
|
27
88
|
|
|
28
89
|
### 2. Code Quality
|
|
@@ -234,16 +295,16 @@ Create `./.sessions/<ISSUE-ID>/pr-description.md`:
|
|
|
234
295
|
3. [Expected result]
|
|
235
296
|
|
|
236
297
|
## 🔍 Notes for Reviewers
|
|
237
|
-
- [
|
|
238
|
-
- [
|
|
298
|
+
- [Point of attention 1]
|
|
299
|
+
- [Point of attention 2]
|
|
239
300
|
```
|
|
240
301
|
|
|
241
302
|
## 🚨 Issues Found
|
|
242
303
|
|
|
243
304
|
If any validation fails:
|
|
244
305
|
1. 🛑 **STOP** the PR creation process
|
|
245
|
-
2. 📝 **DOCUMENT** the
|
|
246
|
-
3. 🔧 **FIX** the
|
|
306
|
+
2. 📝 **DOCUMENT** the problem
|
|
307
|
+
3. 🔧 **FIX** the problem
|
|
247
308
|
4. 🔄 **RUN** `/pre-pr` again
|
|
248
309
|
|
|
249
310
|
## 📊 Validation Report
|
|
@@ -295,4 +356,4 @@ If all validations passed:
|
|
|
295
356
|
/pr
|
|
296
357
|
```
|
|
297
358
|
|
|
298
|
-
This command will create
|
|
359
|
+
This command will create Pull Requests for all modified repositories.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Start of Development
|
|
2
2
|
|
|
3
|
-
This command
|
|
3
|
+
This command initiates the development of a feature in the current workspace.
|
|
4
4
|
|
|
5
5
|
## 📍 IMPORTANT: Understand the Structure
|
|
6
6
|
|
|
@@ -14,7 +14,7 @@ This command starts the development of a feature in the current workspace.
|
|
|
14
14
|
└── plan.md # plan (mutable - created by /plan)
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
**Main
|
|
17
|
+
**Main Repositories** (read-only):
|
|
18
18
|
```
|
|
19
19
|
{base_path}/repo-1/ # main repo (branch main/master)
|
|
20
20
|
{base_path}/repo-2/ # main repo (branch main/master)
|
|
@@ -24,7 +24,44 @@ This command starts the development of a feature in the current workspace.
|
|
|
24
24
|
- ✅ Read metaspecs and code from main repositories (read-only)
|
|
25
25
|
- ✅ Create `context.md` and `architecture.md` in `.sessions/<ISSUE-ID>/`
|
|
26
26
|
- ❌ NEVER checkout main repositories
|
|
27
|
-
- ❌ NEVER modify code in this command (use `/work`
|
|
27
|
+
- ❌ NEVER modify code in this command (use `/work` later)
|
|
28
|
+
|
|
29
|
+
## 📋 Project Configuration
|
|
30
|
+
|
|
31
|
+
**⚠️ IMPORTANT: Always read the project configuration files BEFORE running this command!**
|
|
32
|
+
|
|
33
|
+
### Required Files
|
|
34
|
+
|
|
35
|
+
1. **`context-manifest.json`** (orchestrator root)
|
|
36
|
+
- List of project repositories
|
|
37
|
+
- Roles of each repository (metaspecs, application, etc.)
|
|
38
|
+
- URLs and dependencies among repositories
|
|
39
|
+
|
|
40
|
+
2. **`ai.properties.md`** (orchestrator root)
|
|
41
|
+
- Project settings (`project_name`, `base_path`)
|
|
42
|
+
- Task management system (`task_management_system`)
|
|
43
|
+
- Credentials and specific configurations
|
|
44
|
+
|
|
45
|
+
### How to Read
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
# 1. Read context-manifest.json
|
|
49
|
+
cat context-manifest.json
|
|
50
|
+
|
|
51
|
+
# 2. Read ai.properties.md
|
|
52
|
+
cat ai.properties.md
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Essential Information
|
|
56
|
+
|
|
57
|
+
After reading the files, you will have:
|
|
58
|
+
- ✅ Complete list of project repositories
|
|
59
|
+
- ✅ Location of the metaspecs repository
|
|
60
|
+
- ✅ Base path to locate repositories
|
|
61
|
+
- ✅ Configured task management system
|
|
62
|
+
- ✅ Project-specific configurations
|
|
63
|
+
|
|
64
|
+
**🛑 DO NOT proceed without reading these files!** They contain critical information for correct command execution.
|
|
28
65
|
|
|
29
66
|
## 📚 Load MetaSpecs
|
|
30
67
|
|
|
@@ -33,7 +70,7 @@ This command starts the development of a feature in the current workspace.
|
|
|
33
70
|
2. Find the repository with `"role": "metaspecs"`
|
|
34
71
|
3. Read `ai.properties.md` to get the `base_path`
|
|
35
72
|
4. The metaspecs are at: `{base_path}/{metaspecs-repo-id}/`
|
|
36
|
-
5. Read
|
|
73
|
+
5. Read relevant `index.md` files:
|
|
37
74
|
- Business context
|
|
38
75
|
- Stack, architecture, and technical patterns
|
|
39
76
|
- Project conventions
|
|
@@ -52,7 +89,7 @@ Before starting, load the context by consulting:
|
|
|
52
89
|
- Confirm you are in the correct workspace (check `workspace directory`)
|
|
53
90
|
- List repositories available in the workspace
|
|
54
91
|
|
|
55
|
-
2. **
|
|
92
|
+
2. **Check Branches**:
|
|
56
93
|
- For each repository in the workspace, check the current branch
|
|
57
94
|
- Confirm all branches are synchronized
|
|
58
95
|
|
|
@@ -73,15 +110,15 @@ Analyze the specification and build a complete understanding by answering:
|
|
|
73
110
|
- **Which** metric do we want to impact?
|
|
74
111
|
|
|
75
112
|
### Functional
|
|
76
|
-
- **What is the expected outcome
|
|
113
|
+
- **What is the expected outcome?** (user behavior, system output)
|
|
77
114
|
- **Which components** will be created/modified in each repository?
|
|
78
115
|
- **Which integrations** between repositories are necessary?
|
|
79
116
|
|
|
80
117
|
### Technical
|
|
81
|
-
- **Approved stack
|
|
82
|
-
- **Architectural patterns
|
|
83
|
-
- **New dependencies
|
|
84
|
-
- **How to test
|
|
118
|
+
- **Approved stack?** Check against technical specifications
|
|
119
|
+
- **Architectural patterns?** Check ADRs (if available)
|
|
120
|
+
- **New dependencies?** Justify and document
|
|
121
|
+
- **How to test?** (according to project standards)
|
|
85
122
|
|
|
86
123
|
### Validation against MetaSpecs
|
|
87
124
|
|
|
@@ -97,16 +134,16 @@ After initial analysis, formulate **3-5 most important clarifications**:
|
|
|
97
134
|
|
|
98
135
|
**Examples of relevant questions**:
|
|
99
136
|
- Which repository should contain the main logic?
|
|
100
|
-
- How should
|
|
137
|
+
- How should repositories communicate?
|
|
101
138
|
- Are there dependencies between changes in different repos?
|
|
102
139
|
- What is the recommended implementation order?
|
|
103
|
-
- Is there
|
|
140
|
+
- Is there impact on APIs or contracts between services?
|
|
104
141
|
|
|
105
142
|
## 💾 Creation of Context.md
|
|
106
143
|
|
|
107
144
|
**IMPORTANT**: This file is **IMMUTABLE** after approval. It must not be modified by subsequent commands.
|
|
108
145
|
|
|
109
|
-
Create
|
|
146
|
+
Create file `./.sessions/<ISSUE-ID>/context.md` with:
|
|
110
147
|
|
|
111
148
|
```markdown
|
|
112
149
|
# Context: [Feature Name]
|
|
@@ -135,7 +172,7 @@ Create the file `./.sessions/<ISSUE-ID>/context.md` with:
|
|
|
135
172
|
[Technical limitations, performance targets, budget]
|
|
136
173
|
|
|
137
174
|
## Tests
|
|
138
|
-
[Critical E2E,
|
|
175
|
+
[Critical E2E, necessary unit tests, expected coverage]
|
|
139
176
|
```
|
|
140
177
|
|
|
141
178
|
**After creating `context.md`, request user review and approval before proceeding.**
|
|
@@ -153,17 +190,17 @@ Create the file `./.sessions/<ISSUE-ID>/context.md` with:
|
|
|
153
190
|
1. **Read ADRs (Architecture Decision Records)**:
|
|
154
191
|
- List ADRs in metaspecs
|
|
155
192
|
- Read ALL ADRs relevant to the feature
|
|
156
|
-
- Identify constraints and
|
|
193
|
+
- Identify mandatory constraints and patterns
|
|
157
194
|
|
|
158
195
|
2. **Consult architectural patterns**:
|
|
159
196
|
- Read project structure guides in metaspecs
|
|
160
|
-
- Read
|
|
197
|
+
- Read coding patterns in metaspecs
|
|
161
198
|
- Identify existing patterns in code (use Glob/Grep to find similar examples)
|
|
162
199
|
|
|
163
200
|
3. **Validate compliance with ADRs**:
|
|
164
|
-
- For each relevant ADR,
|
|
201
|
+
- For each relevant ADR, check if the proposed solution respects the decisions
|
|
165
202
|
- Document compliance in architecture.md
|
|
166
|
-
- If
|
|
203
|
+
- If violation exists, justify or propose correction
|
|
167
204
|
|
|
168
205
|
4. **Analyze existing code**:
|
|
169
206
|
- Use Glob/Grep to find similar components/modules
|
|
@@ -172,7 +209,7 @@ Create the file `./.sessions/<ISSUE-ID>/context.md` with:
|
|
|
172
209
|
|
|
173
210
|
### Architecture Document Structure
|
|
174
211
|
|
|
175
|
-
Create
|
|
212
|
+
Create file `./.sessions/<ISSUE-ID>/architecture.md` with:
|
|
176
213
|
|
|
177
214
|
```markdown
|
|
178
215
|
# Architecture: [Feature Name]
|
|
@@ -204,7 +241,7 @@ repo-1/
|
|
|
204
241
|
```
|
|
205
242
|
|
|
206
243
|
## Patterns and Best Practices
|
|
207
|
-
[Patterns
|
|
244
|
+
[Patterns to be maintained or introduced]
|
|
208
245
|
|
|
209
246
|
## ADR Validation
|
|
210
247
|
[List of consulted ADRs and compliance]
|
|
@@ -213,7 +250,7 @@ repo-1/
|
|
|
213
250
|
- [x] ADR-002: [Name] - Compliant
|
|
214
251
|
|
|
215
252
|
## External Dependencies
|
|
216
|
-
[Libraries
|
|
253
|
+
[Libraries to be used or added]
|
|
217
254
|
|
|
218
255
|
## Technical Decisions
|
|
219
256
|
|
|
@@ -226,7 +263,7 @@ repo-1/
|
|
|
226
263
|
**Justification**: [Why we chose this option]
|
|
227
264
|
|
|
228
265
|
## Constraints and Assumptions
|
|
229
|
-
[Technical limitations and
|
|
266
|
+
[Technical limitations and premises]
|
|
230
267
|
|
|
231
268
|
## Trade-offs
|
|
232
269
|
[Alternatives considered and why they were not chosen]
|
|
@@ -262,7 +299,7 @@ repo-1/
|
|
|
262
299
|
|
|
263
300
|
## 🎯 Next Step
|
|
264
301
|
|
|
265
|
-
**After user approval of
|
|
302
|
+
**After user approval of `context.md` and `architecture.md` files**:
|
|
266
303
|
|
|
267
304
|
```bash
|
|
268
305
|
/plan
|
|
@@ -7,11 +7,49 @@ This command executes a unit of work in the current workspace, implementing part
|
|
|
7
7
|
Before executing, make sure that:
|
|
8
8
|
- You have run `/start` and `/plan` to have the technical plan
|
|
9
9
|
- You are in the correct workspace: `<orchestrator>/.sessions/<ISSUE-ID>/`
|
|
10
|
-
- You have the `.sessions/<ISSUE-ID>/`
|
|
10
|
+
- You have the files `.sessions/<ISSUE-ID>/` available:
|
|
11
11
|
- `context.md` (immutable)
|
|
12
12
|
- `architecture.md` (immutable)
|
|
13
13
|
- `plan.md` (mutable)
|
|
14
14
|
|
|
15
|
+
## 📋 Project Configuration
|
|
16
|
+
|
|
17
|
+
**⚠️ IMPORTANT: Always read the project configuration files BEFORE running this command!**
|
|
18
|
+
|
|
19
|
+
### Required Files
|
|
20
|
+
|
|
21
|
+
1. **`context-manifest.json`** (orchestrator root)
|
|
22
|
+
- List of project repositories
|
|
23
|
+
- Roles of each repository (metaspecs, application, etc.)
|
|
24
|
+
- URLs and dependencies between repositories
|
|
25
|
+
|
|
26
|
+
2. **`ai.properties.md`** (orchestrator root)
|
|
27
|
+
- Project settings (`project_name`, `base_path`)
|
|
28
|
+
- Task management system (`task_management_system`)
|
|
29
|
+
- Credentials and specific configurations
|
|
30
|
+
|
|
31
|
+
### How to Read
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
# 1. Read context-manifest.json
|
|
35
|
+
cat context-manifest.json
|
|
36
|
+
|
|
37
|
+
# 2. Read ai.properties.md
|
|
38
|
+
cat ai.properties.md
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Essential Information
|
|
42
|
+
|
|
43
|
+
After reading the files, you will have:
|
|
44
|
+
- ✅ Complete list of project repositories
|
|
45
|
+
- ✅ Location of the metaspecs repository
|
|
46
|
+
- ✅ Base path to locate repositories
|
|
47
|
+
- ✅ Configured task management system
|
|
48
|
+
- ✅ Project-specific configurations
|
|
49
|
+
|
|
50
|
+
**🛑 DO NOT proceed without reading these files!** They contain critical information for the correct execution of the command.
|
|
51
|
+
|
|
52
|
+
|
|
15
53
|
## 📍 IMPORTANT: Understand the Structure
|
|
16
54
|
|
|
17
55
|
**Workspace** (where you work):
|
|
@@ -32,7 +70,7 @@ Before executing, make sure that:
|
|
|
32
70
|
|
|
33
71
|
**GOLDEN RULE**:
|
|
34
72
|
- ✅ Work ONLY inside `<orchestrator>/.sessions/<ISSUE-ID>/`
|
|
35
|
-
- ✅
|
|
73
|
+
- ✅ Commit in the worktrees inside the workspace
|
|
36
74
|
- ❌ NEVER checkout branches in the main repositories
|
|
37
75
|
- ❌ NEVER navigate to `{base_path}/{repo-id}/`
|
|
38
76
|
|
|
@@ -57,7 +95,7 @@ Before executing, make sure that:
|
|
|
57
95
|
**ABSOLUTE RULE**:
|
|
58
96
|
- 🛑 **EVERY code file** (`.ts`, `.js`, `.py`, `.java`, etc.) **MUST be inside** `<orchestrator>/.sessions/<ISSUE-ID>/<repo-name>/`
|
|
59
97
|
- 🛑 **NEVER create code** directly in `<orchestrator>/.sessions/` or `<orchestrator>/.sessions/<ISSUE-ID>/`
|
|
60
|
-
- ✅ **Only valid place**: Inside the
|
|
98
|
+
- ✅ **Only valid place**: Inside the repository’s worktree
|
|
61
99
|
|
|
62
100
|
## ⚠️ IMPORTANT: Immutable Files
|
|
63
101
|
|
|
@@ -67,8 +105,8 @@ Before executing, make sure that:
|
|
|
67
105
|
- ✅ **UPDATE** `.sessions/<ISSUE-ID>/plan.md` (mark progress)
|
|
68
106
|
- ✅ **IMPLEMENT** code **INSIDE THE WORKTREE**: `.sessions/<ISSUE-ID>/<repo-name>/`
|
|
69
107
|
- ✅ **MAKE COMMITS** in the worktrees: `.sessions/<ISSUE-ID>/<repo-name>/`
|
|
70
|
-
- ❌ **
|
|
71
|
-
- ❌ **
|
|
108
|
+
- ❌ **Do NOT modify `context.md` or `architecture.md`**
|
|
109
|
+
- ❌ **Do NOT checkout branches in the main repositories (outside workspace)**
|
|
72
110
|
- 🛑 **NEVER create code directly in `.sessions/` or `.sessions/<ISSUE-ID>/`**
|
|
73
111
|
|
|
74
112
|
## 📚 Load MetaSpecs
|
|
@@ -83,7 +121,7 @@ Before executing, make sure that:
|
|
|
83
121
|
- Respect defined architecture
|
|
84
122
|
- Use correct conventions
|
|
85
123
|
|
|
86
|
-
## 🎯
|
|
124
|
+
## 🎯 Objective
|
|
87
125
|
|
|
88
126
|
Implement a specific unit of work from the plan, which may involve:
|
|
89
127
|
- Creating new files/components
|
|
@@ -124,7 +162,7 @@ Based on the technical plan (`./.sessions/<ISSUE-ID>/plan.md`), identify:
|
|
|
124
162
|
|
|
125
163
|
|
|
126
164
|
|
|
127
|
-
**IMPORTANT**: Work ONLY inside the workspace
|
|
165
|
+
**IMPORTANT**: Work ONLY inside the workspace `.sessions/<ISSUE-ID>/`
|
|
128
166
|
|
|
129
167
|
For each repository in the workspace:
|
|
130
168
|
|