@sk8metal/michi-cli 0.11.0 → 0.12.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/README.md +3 -10
- package/dist/scripts/constants/environments.d.ts +1 -1
- package/dist/scripts/constants/environments.d.ts.map +1 -1
- package/dist/scripts/constants/environments.js +0 -20
- package/dist/scripts/constants/environments.js.map +1 -1
- package/dist/scripts/utils/template-finder.d.ts +2 -2
- package/dist/scripts/utils/template-finder.d.ts.map +1 -1
- package/dist/scripts/utils/template-finder.js +3 -8
- package/dist/scripts/utils/template-finder.js.map +1 -1
- package/dist/src/cli.d.ts.map +1 -1
- package/dist/src/cli.js +0 -8
- package/dist/src/cli.js.map +1 -1
- package/dist/src/commands/init.d.ts +0 -4
- package/dist/src/commands/init.d.ts.map +1 -1
- package/dist/src/commands/init.js +6 -30
- package/dist/src/commands/init.js.map +1 -1
- package/dist/src/commands/setup-existing.d.ts +2 -6
- package/dist/src/commands/setup-existing.d.ts.map +1 -1
- package/dist/src/commands/setup-existing.js +8 -142
- package/dist/src/commands/setup-existing.js.map +1 -1
- package/docs/getting-started/configuration.md +0 -29
- package/docs/getting-started/quick-start.md +2 -2
- package/docs/guides/workflow.md +1 -1
- package/docs/reference/cli.md +0 -4
- package/docs/troubleshooting.md +0 -45
- package/package.json +1 -3
- package/scripts/__tests__/create-project.test.ts +12 -12
- package/scripts/__tests__/setup-existing-project.test.ts +22 -22
- package/scripts/constants/__tests__/environments.test.ts +7 -50
- package/scripts/constants/environments.ts +1 -27
- package/scripts/template/__tests__/renderer.test.ts +21 -21
- package/scripts/utils/template-finder.ts +5 -11
- package/docs/guides/ai-tools.md +0 -311
- package/templates/cline/rules/atlassian-integration.md +0 -36
- package/templates/cline/rules/michi-core.md +0 -56
- package/templates/codex/AGENTS.override.md +0 -277
- package/templates/codex/prompts/confluence-sync.md +0 -177
- package/templates/codex/rules/README.md +0 -210
- package/templates/cursor/commands/kiro/kiro-spec-impl.md +0 -244
- package/templates/cursor/commands/kiro/kiro-spec-tasks.md +0 -354
- package/templates/cursor/commands/michi/confluence-sync.md +0 -76
- package/templates/cursor/commands/michi/project-switch.md +0 -69
- package/templates/cursor/commands/michi/spec-tasks.md +0 -117
- package/templates/cursor/rules/atlassian-mcp.mdc +0 -188
- package/templates/cursor/rules/github-ssot.mdc +0 -151
- package/templates/cursor/rules/multi-project.mdc +0 -81
- package/templates/gemini/commands/README.md +0 -41
- package/templates/gemini/rules/GEMINI.md +0 -80
|
@@ -1,244 +0,0 @@
|
|
|
1
|
-
# kiro:spec-impl - Spec Implementation Command
|
|
2
|
-
|
|
3
|
-
## Overview
|
|
4
|
-
|
|
5
|
-
This command implements the specifications defined in `tasks.md` following TDD (Test-Driven Development) practices with automatic JIRA integration.
|
|
6
|
-
|
|
7
|
-
**Key Features:**
|
|
8
|
-
|
|
9
|
-
- Automatic JIRA info detection from `spec.json`
|
|
10
|
-
- Updates both Epic AND first Story status
|
|
11
|
-
- Creates PR and adds JIRA comments automatically
|
|
12
|
-
|
|
13
|
-
## Arguments
|
|
14
|
-
|
|
15
|
-
- `$ARGUMENTS`: Feature name (e.g., "user-auth")
|
|
16
|
-
|
|
17
|
-
**Note:** JIRA ticket keys are automatically detected from `.kiro/specs/{feature}/spec.json`. No need to specify them manually.
|
|
18
|
-
|
|
19
|
-
## Pre-requisites
|
|
20
|
-
|
|
21
|
-
1. `.kiro/specs/{feature}/tasks.md` must exist
|
|
22
|
-
2. `.kiro/specs/{feature}/spec.json` must contain JIRA info (run `michi jira:sync` first)
|
|
23
|
-
3. Environment variables must be configured:
|
|
24
|
-
- `ATLASSIAN_URL`: JIRA instance URL
|
|
25
|
-
- `ATLASSIAN_EMAIL`: JIRA user email
|
|
26
|
-
- `ATLASSIAN_API_TOKEN`: JIRA API token
|
|
27
|
-
- `GITHUB_TOKEN`: GitHub API token
|
|
28
|
-
- ~~`GITHUB_REPO`: GitHub repository (owner/repo format)~~ **Deprecated (v0.5.0+)**: Repository info is now automatically loaded from `.kiro/project.json`
|
|
29
|
-
|
|
30
|
-
## Execution Flow
|
|
31
|
-
|
|
32
|
-
### 1. Parse Arguments
|
|
33
|
-
|
|
34
|
-
```
|
|
35
|
-
Input: $ARGUMENTS
|
|
36
|
-
Expected format: "<feature-name>"
|
|
37
|
-
Example: "user-auth"
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
Extract:
|
|
41
|
-
|
|
42
|
-
- `FEATURE_NAME`: Feature name from arguments
|
|
43
|
-
|
|
44
|
-
### 2. JIRA Info Detection (Automatic)
|
|
45
|
-
|
|
46
|
-
Read JIRA information from `.kiro/specs/$FEATURE_NAME/spec.json`:
|
|
47
|
-
|
|
48
|
-
```json
|
|
49
|
-
{
|
|
50
|
-
"jira": {
|
|
51
|
-
"epicKey": "PROJ-123",
|
|
52
|
-
"storyKeys": ["PROJ-124", "PROJ-125"],
|
|
53
|
-
"epicUrl": "https://..."
|
|
54
|
-
}
|
|
55
|
-
}
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
**If JIRA info is missing:**
|
|
59
|
-
|
|
60
|
-
- Ask user: "JIRA info not found. Skip JIRA integration? (y/n)"
|
|
61
|
-
- If yes: Continue without JIRA integration
|
|
62
|
-
- If no: Stop and suggest running `michi jira:sync $FEATURE_NAME` first
|
|
63
|
-
|
|
64
|
-
### 3. Start Processing (JIRA Status Update)
|
|
65
|
-
|
|
66
|
-
**Automatically move Epic AND first Story to "In Progress":**
|
|
67
|
-
|
|
68
|
-
This is handled internally. The workflow will:
|
|
69
|
-
|
|
70
|
-
1. Transition Epic to "In Progress"
|
|
71
|
-
2. Transition first Story to "In Progress"
|
|
72
|
-
|
|
73
|
-
### 4. Implementation Phase (TDD)
|
|
74
|
-
|
|
75
|
-
Read the tasks from `.kiro/specs/$FEATURE_NAME/tasks.md` and implement each Story following TDD:
|
|
76
|
-
|
|
77
|
-
For each Story in tasks.md:
|
|
78
|
-
|
|
79
|
-
1. **Read Story Requirements**
|
|
80
|
-
- Parse the Story section from tasks.md
|
|
81
|
-
- Identify acceptance criteria and subtasks
|
|
82
|
-
|
|
83
|
-
2. **Write Tests First (Red)**
|
|
84
|
-
- Create test files based on acceptance criteria
|
|
85
|
-
- Run tests to verify they fail
|
|
86
|
-
|
|
87
|
-
3. **Implement Code (Green)**
|
|
88
|
-
- Write minimal code to pass tests
|
|
89
|
-
- Follow the existing code patterns in the project
|
|
90
|
-
|
|
91
|
-
4. **Refactor (Blue)**
|
|
92
|
-
- Clean up code while keeping tests green
|
|
93
|
-
- Apply project coding standards
|
|
94
|
-
|
|
95
|
-
5. **Commit Changes**
|
|
96
|
-
- Create atomic commits for each Story
|
|
97
|
-
- Use conventional commit format: `feat($FEATURE_NAME): Story title`
|
|
98
|
-
|
|
99
|
-
### 5. Code Review Phase (Automatic)
|
|
100
|
-
|
|
101
|
-
**Automatically review the implemented code:**
|
|
102
|
-
|
|
103
|
-
For each Story implementation:
|
|
104
|
-
|
|
105
|
-
1. **Code Review (/review)**
|
|
106
|
-
- Execute `/review` command automatically
|
|
107
|
-
- Analyze the implementation for code quality issues
|
|
108
|
-
- Check for best practices and potential bugs
|
|
109
|
-
|
|
110
|
-
2. **Fix Issues if Found**
|
|
111
|
-
- If review identifies issues, automatically fix them
|
|
112
|
-
- Commit the fixes
|
|
113
|
-
- Re-run `/review` to verify fixes
|
|
114
|
-
- Repeat until `/review` passes without critical issues
|
|
115
|
-
|
|
116
|
-
3. **Security Review (/security-review)**
|
|
117
|
-
- Execute `/security-review` command automatically
|
|
118
|
-
- Scan for security vulnerabilities
|
|
119
|
-
- Check for common security issues (SQL injection, XSS, etc.)
|
|
120
|
-
|
|
121
|
-
4. **Fix Security Issues if Found**
|
|
122
|
-
- If security issues are identified, automatically fix them
|
|
123
|
-
- Commit the security fixes
|
|
124
|
-
- Re-run `/security-review` to verify fixes
|
|
125
|
-
- Repeat until `/security-review` passes without critical issues
|
|
126
|
-
|
|
127
|
-
**Review Loop:**
|
|
128
|
-
- Maximum iterations: 3 per review type
|
|
129
|
-
- If issues persist after 3 iterations, report to user and ask for manual intervention
|
|
130
|
-
|
|
131
|
-
### 6. PR Creation Confirmation
|
|
132
|
-
|
|
133
|
-
**Ask user before creating PR:**
|
|
134
|
-
|
|
135
|
-
After all reviews pass successfully, ask the user:
|
|
136
|
-
|
|
137
|
-
```
|
|
138
|
-
✅ All reviews completed successfully!
|
|
139
|
-
- Code Review: PASSED
|
|
140
|
-
- Security Review: PASSED
|
|
141
|
-
|
|
142
|
-
Would you like to create a Pull Request now? (y/n)
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
- **If yes**: Proceed to End Processing (Step 7)
|
|
146
|
-
- **If no**: Stop workflow, save current state
|
|
147
|
-
- User can manually create PR later using:
|
|
148
|
-
- `jj git push --bookmark <branch-name>`
|
|
149
|
-
- `gh pr create --head <branch-name> --base main`
|
|
150
|
-
|
|
151
|
-
### 7. End Processing (PR Creation & JIRA Update)
|
|
152
|
-
|
|
153
|
-
**Automatically complete the workflow:**
|
|
154
|
-
|
|
155
|
-
This is handled internally. The workflow will:
|
|
156
|
-
|
|
157
|
-
1. Push the branch to remote
|
|
158
|
-
2. Create a Pull Request on GitHub
|
|
159
|
-
3. Move Epic AND first Story to "Ready for Review"
|
|
160
|
-
4. Add PR link as a comment on the Epic
|
|
161
|
-
|
|
162
|
-
## Usage Examples
|
|
163
|
-
|
|
164
|
-
```
|
|
165
|
-
/kiro:spec-impl user-auth
|
|
166
|
-
```
|
|
167
|
-
|
|
168
|
-
```
|
|
169
|
-
/kiro:spec-impl payment-gateway
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
## Workflow Comparison
|
|
173
|
-
|
|
174
|
-
### Before (3 steps with manual JIRA keys)
|
|
175
|
-
|
|
176
|
-
```bash
|
|
177
|
-
michi spec-impl:start user-auth PROJ-123
|
|
178
|
-
/kiro:spec-impl user-auth PROJ-123
|
|
179
|
-
michi spec-impl:complete user-auth PROJ-123
|
|
180
|
-
```
|
|
181
|
-
|
|
182
|
-
### After (1 command with auto-detection)
|
|
183
|
-
|
|
184
|
-
```
|
|
185
|
-
/kiro:spec-impl user-auth
|
|
186
|
-
# JIRA info auto-detected from spec.json
|
|
187
|
-
# Epic + first Story -> "In Progress"
|
|
188
|
-
# TDD implementation
|
|
189
|
-
# Automatic code review (/review)
|
|
190
|
-
# - Fix issues if found
|
|
191
|
-
# - Re-review until passed
|
|
192
|
-
# Automatic security review (/security-review)
|
|
193
|
-
# - Fix security issues if found
|
|
194
|
-
# - Re-review until passed
|
|
195
|
-
# Ask user: "Create PR now? (y/n)"
|
|
196
|
-
# - If yes:
|
|
197
|
-
# - PR creation
|
|
198
|
-
# - Epic + first Story -> "Ready for Review"
|
|
199
|
-
# - PR link commented on JIRA
|
|
200
|
-
# - If no:
|
|
201
|
-
# - Save state, exit workflow
|
|
202
|
-
```
|
|
203
|
-
|
|
204
|
-
## JIRA Status Mapping
|
|
205
|
-
|
|
206
|
-
Default status names (customizable in `.michi/config.json`):
|
|
207
|
-
|
|
208
|
-
| Phase | Default Status | Targets |
|
|
209
|
-
| ----- | ---------------- | ------------------ |
|
|
210
|
-
| Start | In Progress | Epic + First Story |
|
|
211
|
-
| End | Ready for Review | Epic + First Story |
|
|
212
|
-
|
|
213
|
-
To customize, add to `.michi/config.json`:
|
|
214
|
-
|
|
215
|
-
```json
|
|
216
|
-
{
|
|
217
|
-
"jira": {
|
|
218
|
-
"statusMapping": {
|
|
219
|
-
"inProgress": "In Progress",
|
|
220
|
-
"readyForReview": "Ready for Review"
|
|
221
|
-
}
|
|
222
|
-
}
|
|
223
|
-
}
|
|
224
|
-
```
|
|
225
|
-
|
|
226
|
-
## Error Handling
|
|
227
|
-
|
|
228
|
-
- **JIRA info not found**: Interactive prompt to skip JIRA integration
|
|
229
|
-
- **JIRA transition fails**: Check available transitions for the current status
|
|
230
|
-
- **Review fails (max iterations exceeded)**: Report issues to user and ask for manual intervention
|
|
231
|
-
- **Security review fails (max iterations exceeded)**: Report vulnerabilities to user and ask for manual intervention
|
|
232
|
-
- **User declines PR creation**: Save current state, workflow stops (user can create PR manually later)
|
|
233
|
-
- **PR creation fails**: Ensure the branch is pushed to remote
|
|
234
|
-
- **JIRA comment fails**: The PR URL is still returned for manual update
|
|
235
|
-
|
|
236
|
-
## Notes
|
|
237
|
-
|
|
238
|
-
- JIRA info is automatically detected from `spec.json` (populated by `michi jira:sync`)
|
|
239
|
-
- Both Epic AND first Story are updated together
|
|
240
|
-
- The branch name defaults to `feature/{feature-name}`
|
|
241
|
-
- Individual JIRA operations can still be done via `michi jira:transition` and `michi jira:comment`
|
|
242
|
-
- Code reviews (`/review` and `/security-review`) are executed automatically after implementation
|
|
243
|
-
- Review loop has a maximum of 3 iterations per review type to prevent infinite loops
|
|
244
|
-
- User can decline PR creation and manually create it later if needed
|
|
@@ -1,354 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: /kiro:spec-tasks
|
|
3
|
-
description: Generate tasks.md from design specification in Michi workflow format
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Generate Tasks from Design Specification
|
|
7
|
-
|
|
8
|
-
**Important**: Generate output in the language specified in `{{KIRO_DIR}}/project.json`.
|
|
9
|
-
|
|
10
|
-
## Overview
|
|
11
|
-
|
|
12
|
-
This command generates a detailed task breakdown (`tasks.md`) from the design specification (`design.md`) following the **Michi Workflow Format**.
|
|
13
|
-
|
|
14
|
-
**Critical**: The generated tasks.md MUST follow the Michi Phase structure (Phase 0.1-5, A, B) with Story headers. DO NOT generate AI-DLC checkbox format (`- [ ] 1.`, `- [ ] 1.1`).
|
|
15
|
-
|
|
16
|
-
## Usage
|
|
17
|
-
|
|
18
|
-
```
|
|
19
|
-
/kiro:spec-tasks
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
## Input Files
|
|
23
|
-
|
|
24
|
-
1. `{{KIRO_DIR}}/specs/{{FEATURE_NAME}}/design.md` - Design specification
|
|
25
|
-
2. `{{KIRO_DIR}}/specs/{{FEATURE_NAME}}/requirements.md` - Requirements specification
|
|
26
|
-
3. `{{KIRO_DIR}}/project.json` - Project metadata
|
|
27
|
-
|
|
28
|
-
## Output File
|
|
29
|
-
|
|
30
|
-
`{{KIRO_DIR}}/specs/{{FEATURE_NAME}}/tasks.md`
|
|
31
|
-
|
|
32
|
-
## Required Format: Michi Workflow Structure
|
|
33
|
-
|
|
34
|
-
### Header Section
|
|
35
|
-
|
|
36
|
-
```markdown
|
|
37
|
-
# Task Breakdown: {{FEATURE_NAME}}
|
|
38
|
-
|
|
39
|
-
## Project Information
|
|
40
|
-
|
|
41
|
-
- **Feature Name**: {{FEATURE_NAME}}
|
|
42
|
-
- **Start Date**: YYYY-MM-DD (Day of week) Day 1
|
|
43
|
-
- **End Date**: YYYY-MM-DD (Day of week)
|
|
44
|
-
- **Total Business Days**: X business days (excluding weekends)
|
|
45
|
-
- **Total Effort Estimate**: X person-days
|
|
46
|
-
- **Holidays**: Excludes Saturdays and Sundays
|
|
47
|
-
- **Note**: This task breakdown is calculated in business days (excluding weekends and holidays)
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
### Phase Structure (Required)
|
|
51
|
-
|
|
52
|
-
The tasks.md MUST include these phases in order:
|
|
53
|
-
|
|
54
|
-
1. **Phase 0.1: Requirements**
|
|
55
|
-
2. **Phase 0.2: Design**
|
|
56
|
-
3. **Phase 0.3: Test Type Selection** (optional)
|
|
57
|
-
4. **Phase 0.4: Test Specification** (optional)
|
|
58
|
-
5. **Phase 1: Environment Setup** (optional)
|
|
59
|
-
6. **Phase 2: TDD Implementation** (required - main development phase)
|
|
60
|
-
7. **Phase A: PR Pre-merge Tests** (optional - CI/CD automated)
|
|
61
|
-
8. **Phase 3: Additional QA** (optional)
|
|
62
|
-
9. **Phase B: Release Preparation Tests** (optional)
|
|
63
|
-
10. **Phase 4: Release Preparation**
|
|
64
|
-
11. **Phase 5: Release**
|
|
65
|
-
|
|
66
|
-
### Phase Header Format
|
|
67
|
-
|
|
68
|
-
Each phase MUST use this header format:
|
|
69
|
-
|
|
70
|
-
```markdown
|
|
71
|
-
## Phase X.Y: Phase Name (Label)
|
|
72
|
-
|
|
73
|
-
**Period**: Day X-Y
|
|
74
|
-
**Effort**: X person-days
|
|
75
|
-
**Status**: Not Started
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
### Story Header Format
|
|
79
|
-
|
|
80
|
-
Each story within a phase MUST use this format:
|
|
81
|
-
|
|
82
|
-
```markdown
|
|
83
|
-
### Story X.Y.Z: Story Title
|
|
84
|
-
|
|
85
|
-
- **Assignee**: @Role
|
|
86
|
-
- **Effort**: X person-days
|
|
87
|
-
- **Description**: What this story accomplishes
|
|
88
|
-
- **Deliverables**:
|
|
89
|
-
- Deliverable 1
|
|
90
|
-
- Deliverable 2
|
|
91
|
-
- **Acceptance Criteria**:
|
|
92
|
-
- [ ] Criterion 1
|
|
93
|
-
- [ ] Criterion 2
|
|
94
|
-
- **Tasks**:
|
|
95
|
-
- [ ] Task X.Y.Z.1: Task description
|
|
96
|
-
- [ ] Task X.Y.Z.2: Task description
|
|
97
|
-
- **Dependencies**: Story X.Y.W (if applicable)
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
## Detailed Phase Guidelines
|
|
101
|
-
|
|
102
|
-
### Phase 0.1: Requirements
|
|
103
|
-
|
|
104
|
-
```markdown
|
|
105
|
-
## Phase 0.1: Requirements (Requirements)
|
|
106
|
-
|
|
107
|
-
**Period**: Day 1
|
|
108
|
-
**Effort**: 0.5 person-days
|
|
109
|
-
**Status**: Not Started
|
|
110
|
-
|
|
111
|
-
### Story 0.1.1: Requirements Document Creation
|
|
112
|
-
|
|
113
|
-
- **Assignee**: @PM
|
|
114
|
-
- **Effort**: 0.5 person-days
|
|
115
|
-
- **Description**: Create feature requirements document
|
|
116
|
-
- **Deliverables**:
|
|
117
|
-
- `.kiro/specs/{{FEATURE_NAME}}/requirements.md`
|
|
118
|
-
- Confluence page (Requirements)
|
|
119
|
-
- **Acceptance Criteria**:
|
|
120
|
-
- [ ] Functional requirements defined
|
|
121
|
-
- [ ] Non-functional requirements defined
|
|
122
|
-
- [ ] Use cases documented
|
|
123
|
-
- [ ] PM approved
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
### Phase 0.2: Design
|
|
127
|
-
|
|
128
|
-
```markdown
|
|
129
|
-
## Phase 0.2: Design (Design)
|
|
130
|
-
|
|
131
|
-
**Period**: Day 1-2
|
|
132
|
-
**Effort**: 0.5-1.0 person-days
|
|
133
|
-
**Status**: Not Started
|
|
134
|
-
|
|
135
|
-
### Story 0.2.1: Basic Design
|
|
136
|
-
|
|
137
|
-
- **Assignee**: @Architect
|
|
138
|
-
- **Effort**: 0.5-1.0 person-days
|
|
139
|
-
- **Description**: Architecture design, API design, class design
|
|
140
|
-
- **Deliverables**:
|
|
141
|
-
- `.kiro/specs/{{FEATURE_NAME}}/design.md`
|
|
142
|
-
- Confluence page (Design Document)
|
|
143
|
-
- **Acceptance Criteria**:
|
|
144
|
-
- [ ] System architecture diagram created
|
|
145
|
-
- [ ] Layer structure defined
|
|
146
|
-
- [ ] API specifications detailed
|
|
147
|
-
- [ ] Class design completed
|
|
148
|
-
- [ ] Architect approved
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
### Phase 2: TDD Implementation (Main Development)
|
|
152
|
-
|
|
153
|
-
This is the most detailed phase. Break down into multiple stories based on the design.md:
|
|
154
|
-
|
|
155
|
-
```markdown
|
|
156
|
-
## Phase 2: TDD Implementation (Implementation)
|
|
157
|
-
|
|
158
|
-
**Period**: Day X-Y
|
|
159
|
-
**Effort**: X person-days
|
|
160
|
-
**Status**: Not Started
|
|
161
|
-
|
|
162
|
-
### Story 2.1: Project Setup
|
|
163
|
-
|
|
164
|
-
- **Assignee**: @Developer
|
|
165
|
-
- **Effort**: 0.5 person-days
|
|
166
|
-
- **Description**: Project setup and dependency configuration
|
|
167
|
-
- **Tasks**:
|
|
168
|
-
- [ ] Task 2.1.1: Create project
|
|
169
|
-
- [ ] Task 2.1.2: Add dependencies
|
|
170
|
-
- [ ] Task 2.1.3: Create configuration files
|
|
171
|
-
- [ ] Task 2.1.4: Create package structure
|
|
172
|
-
- [ ] Task 2.1.5: Verify build
|
|
173
|
-
- **Deliverables**:
|
|
174
|
-
- Project configuration files
|
|
175
|
-
- Package structure
|
|
176
|
-
- **Acceptance Criteria**:
|
|
177
|
-
- [ ] Project builds successfully
|
|
178
|
-
- [ ] Application starts
|
|
179
|
-
- [ ] Package structure matches design
|
|
180
|
-
|
|
181
|
-
### Story 2.2: [Feature Component] Implementation
|
|
182
|
-
|
|
183
|
-
- **Assignee**: @Developer
|
|
184
|
-
- **Effort**: X person-days
|
|
185
|
-
- **Description**: Implement [component] with TDD approach
|
|
186
|
-
- **Tasks**:
|
|
187
|
-
- [ ] Task 2.2.1: Write failing tests (RED)
|
|
188
|
-
- [ ] Task 2.2.2: Implement minimum code (GREEN)
|
|
189
|
-
- [ ] Task 2.2.3: Refactor (REFACTOR)
|
|
190
|
-
- [ ] Task 2.2.4: Integration tests
|
|
191
|
-
- **Acceptance Criteria**:
|
|
192
|
-
- [ ] All unit tests pass
|
|
193
|
-
- [ ] Code coverage >= 95%
|
|
194
|
-
- [ ] Design patterns followed
|
|
195
|
-
|
|
196
|
-
(Continue with Story 2.3, 2.4, etc. based on design.md components)
|
|
197
|
-
```
|
|
198
|
-
|
|
199
|
-
### Phase 4: Release Preparation
|
|
200
|
-
|
|
201
|
-
```markdown
|
|
202
|
-
## Phase 4: Release Preparation (Release Preparation)
|
|
203
|
-
|
|
204
|
-
**Period**: Day Y-Z
|
|
205
|
-
**Effort**: X person-days
|
|
206
|
-
**Status**: Not Started
|
|
207
|
-
|
|
208
|
-
### Story 4.1: Production Environment Setup
|
|
209
|
-
|
|
210
|
-
- **Assignee**: @InfraEngineer
|
|
211
|
-
- **Effort**: X person-days
|
|
212
|
-
- **Description**: Production infrastructure setup and configuration
|
|
213
|
-
- **Acceptance Criteria**:
|
|
214
|
-
- [ ] Server provisioned
|
|
215
|
-
- [ ] Database configured
|
|
216
|
-
- [ ] SSL certificate configured
|
|
217
|
-
- [ ] Monitoring configured
|
|
218
|
-
|
|
219
|
-
### Story 4.2: Release Documentation
|
|
220
|
-
|
|
221
|
-
- **Assignee**: @PM
|
|
222
|
-
- **Effort**: X person-days
|
|
223
|
-
- **Description**: Release notes, manual, operation procedures
|
|
224
|
-
- **Acceptance Criteria**:
|
|
225
|
-
- [ ] Release notes created
|
|
226
|
-
- [ ] User manual created
|
|
227
|
-
- [ ] Operation procedures created
|
|
228
|
-
```
|
|
229
|
-
|
|
230
|
-
### Phase 5: Release
|
|
231
|
-
|
|
232
|
-
```markdown
|
|
233
|
-
## Phase 5: Release (Release)
|
|
234
|
-
|
|
235
|
-
**Period**: Day Z
|
|
236
|
-
**Effort**: X person-days
|
|
237
|
-
**Status**: Not Started
|
|
238
|
-
|
|
239
|
-
### Story 5.1: Staging Deployment
|
|
240
|
-
|
|
241
|
-
- **Assignee**: @InfraEngineer
|
|
242
|
-
- **Effort**: X person-days
|
|
243
|
-
- **Description**: Deploy to staging and final verification
|
|
244
|
-
- **Acceptance Criteria**:
|
|
245
|
-
- [ ] Staging deployment successful
|
|
246
|
-
- [ ] Smoke tests pass
|
|
247
|
-
- [ ] Final verification completed
|
|
248
|
-
|
|
249
|
-
### Story 5.2: Production Release
|
|
250
|
-
|
|
251
|
-
- **Assignee**: @InfraEngineer, @PM
|
|
252
|
-
- **Effort**: X person-days
|
|
253
|
-
- **Description**: Production release execution
|
|
254
|
-
- **Acceptance Criteria**:
|
|
255
|
-
- [ ] Production deployment successful
|
|
256
|
-
- [ ] Smoke tests pass
|
|
257
|
-
- [ ] Monitoring verified
|
|
258
|
-
- [ ] Stakeholders notified
|
|
259
|
-
```
|
|
260
|
-
|
|
261
|
-
## Timeline Section
|
|
262
|
-
|
|
263
|
-
Include a timeline at the end:
|
|
264
|
-
|
|
265
|
-
```markdown
|
|
266
|
-
## Timeline (Business Days)
|
|
267
|
-
|
|
268
|
-
**Assumption**: Calculated in business days (excluding weekends)
|
|
269
|
-
|
|
270
|
-
### Week 1: Specification Phase
|
|
271
|
-
|
|
272
|
-
Day 1 (Mon):
|
|
273
|
-
|
|
274
|
-
- Story 0.1.1: Requirements Document Creation
|
|
275
|
-
- Story 0.2.1: Basic Design (start)
|
|
276
|
-
|
|
277
|
-
Day 2-3 (Tue-Wed):
|
|
278
|
-
|
|
279
|
-
- Story 0.2.1: Basic Design (complete)
|
|
280
|
-
- Technical review and PM approval
|
|
281
|
-
|
|
282
|
-
### Week 2-N: Implementation Phase
|
|
283
|
-
|
|
284
|
-
(Continue based on project scope)
|
|
285
|
-
```
|
|
286
|
-
|
|
287
|
-
## Estimate Summary Section
|
|
288
|
-
|
|
289
|
-
```markdown
|
|
290
|
-
## Estimate Summary
|
|
291
|
-
|
|
292
|
-
| Phase | Story Points | Effort (days) | Stories |
|
|
293
|
-
| ---------------------------- | ------------ | ------------- | ------- |
|
|
294
|
-
| Phase 0.1: Requirements | X SP | X days | X |
|
|
295
|
-
| Phase 0.2: Design | X SP | X days | X |
|
|
296
|
-
| Phase 2: TDD Implementation | X SP | X days | X |
|
|
297
|
-
| Phase 4: Release Preparation | X SP | X days | X |
|
|
298
|
-
| Phase 5: Release | X SP | X days | X |
|
|
299
|
-
| **Total** | **X SP** | **X days** | **X** |
|
|
300
|
-
|
|
301
|
-
**Conversion Rate**: 1 SP ≈ 0.5 person-days
|
|
302
|
-
```
|
|
303
|
-
|
|
304
|
-
## JIRA Labels Section
|
|
305
|
-
|
|
306
|
-
```markdown
|
|
307
|
-
## JIRA Labels
|
|
308
|
-
|
|
309
|
-
Each story is automatically assigned the following labels:
|
|
310
|
-
|
|
311
|
-
- `requirements` - Phase 0.1: Requirements
|
|
312
|
-
- `design` - Phase 0.2: Design
|
|
313
|
-
- `test-type-selection` - Phase 0.3: Test Type Selection
|
|
314
|
-
- `test-spec` - Phase 0.4: Test Specification
|
|
315
|
-
- `environment-setup` - Phase 1: Environment Setup
|
|
316
|
-
- `implementation` / `tdd-implementation` - Phase 2: TDD Implementation
|
|
317
|
-
- `phase-a` / `pr-tests` - Phase A: PR Pre-merge Tests
|
|
318
|
-
- `additional-qa` / `testing` - Phase 3: Additional QA
|
|
319
|
-
- `phase-b` / `release-tests` - Phase B: Release Preparation Tests
|
|
320
|
-
- `release-prep` / `release-preparation` - Phase 4: Release Preparation
|
|
321
|
-
- `release` - Phase 5: Release
|
|
322
|
-
```
|
|
323
|
-
|
|
324
|
-
## Important Notes
|
|
325
|
-
|
|
326
|
-
1. **DO NOT** use AI-DLC checkbox format (`- [ ] 1.`, `- [ ] 1.1`)
|
|
327
|
-
2. **MUST** use Phase headers (`## Phase X.Y:`)
|
|
328
|
-
3. **MUST** use Story headers (`### Story X.Y.Z:`)
|
|
329
|
-
4. **MUST** include day numbering (Day 1, Day 2, etc.)
|
|
330
|
-
5. **MUST** include effort estimates in person-days
|
|
331
|
-
6. **MUST** include acceptance criteria with checkboxes
|
|
332
|
-
7. Break down Phase 2 stories based on the components in design.md
|
|
333
|
-
8. Ensure each Story has clear dependencies documented
|
|
334
|
-
|
|
335
|
-
## Execution Steps
|
|
336
|
-
|
|
337
|
-
1. Read `{{KIRO_DIR}}/specs/{{FEATURE_NAME}}/design.md`
|
|
338
|
-
2. Read `{{KIRO_DIR}}/specs/{{FEATURE_NAME}}/requirements.md`
|
|
339
|
-
3. Analyze design components and create Story breakdown
|
|
340
|
-
4. Generate `tasks.md` following the Michi Workflow Format above
|
|
341
|
-
5. Save to `{{KIRO_DIR}}/specs/{{FEATURE_NAME}}/tasks.md`
|
|
342
|
-
|
|
343
|
-
## Validation Checklist
|
|
344
|
-
|
|
345
|
-
Before finalizing, verify:
|
|
346
|
-
|
|
347
|
-
- [ ] Phase headers exist (Phase 0.1, 0.2, 2, 4, 5 at minimum)
|
|
348
|
-
- [ ] Story headers follow format (`### Story X.Y.Z:`)
|
|
349
|
-
- [ ] Day numbering is present
|
|
350
|
-
- [ ] Effort estimates are included
|
|
351
|
-
- [ ] Acceptance criteria use checkboxes `- [ ]`
|
|
352
|
-
- [ ] No AI-DLC format (`- [ ] 1.`, `- [ ] 1.1`) is used
|
|
353
|
-
- [ ] Timeline section is included
|
|
354
|
-
- [ ] Estimate summary table is included
|
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: /michi:confluence-sync
|
|
3
|
-
description: GitHub の Markdown を Confluence に同期
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Confluence同期コマンド
|
|
7
|
-
|
|
8
|
-
{{DEV_GUIDELINES}}
|
|
9
|
-
|
|
10
|
-
このコマンドは、GitHubで管理されている仕様書(requirements, design, tasks)をConfluenceに同期します。
|
|
11
|
-
|
|
12
|
-
## 使い方
|
|
13
|
-
|
|
14
|
-
```
|
|
15
|
-
/michi:confluence-sync <feature_name> [doc_type]
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
**パラメータ**:
|
|
19
|
-
- `feature_name`: 機能名(例: user-auth)
|
|
20
|
-
- `doc_type`: ドキュメントタイプ(requirements / design / tasks)省略時は requirements
|
|
21
|
-
|
|
22
|
-
**例**:
|
|
23
|
-
```
|
|
24
|
-
/michi:confluence-sync user-auth
|
|
25
|
-
/michi:confluence-sync user-auth design
|
|
26
|
-
/michi:confluence-sync user-auth tasks
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
## 実行内容
|
|
30
|
-
|
|
31
|
-
1. `{{KIRO_DIR}}/project.json` からプロジェクトメタデータを読み込み
|
|
32
|
-
2. `{{KIRO_DIR}}/specs/<feature>/<doc_type>.md` を読み込み
|
|
33
|
-
3. Markdown → Confluence Storage Format に変換
|
|
34
|
-
4. GitHub URLを埋め込み
|
|
35
|
-
5. Confluenceページを作成または更新
|
|
36
|
-
6. ラベル付与(プロジェクトラベル + doc_type)
|
|
37
|
-
7. ステークホルダーにメンション通知
|
|
38
|
-
|
|
39
|
-
## 生成されるConfluenceページ
|
|
40
|
-
|
|
41
|
-
**タイトル**: `[プロジェクト名] <feature> <doc_type>`
|
|
42
|
-
**スペース**: PRD(要件・設計)/ QA(テスト)
|
|
43
|
-
**ラベル**: project:<project_id>, <doc_type>, <feature_name>, github-sync
|
|
44
|
-
|
|
45
|
-
**ページ構成**:
|
|
46
|
-
- GitHub連携情報(最新版へのリンク)
|
|
47
|
-
- 変換されたMarkdownコンテンツ
|
|
48
|
-
- 承認マクロ(企画・部長への承認依頼)
|
|
49
|
-
|
|
50
|
-
## 実装
|
|
51
|
-
|
|
52
|
-
スクリプトを直接実行:
|
|
53
|
-
|
|
54
|
-
```bash
|
|
55
|
-
npm run confluence:sync <feature_name> [doc_type]
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
内部的に `scripts/confluence-sync.ts` を実行します。
|
|
59
|
-
|
|
60
|
-
## 前提条件
|
|
61
|
-
|
|
62
|
-
- `.env` ファイルに Atlassian 認証情報が設定されている
|
|
63
|
-
- `{{KIRO_DIR}}/project.json` が存在する
|
|
64
|
-
- 同期する Markdown ファイルが存在する
|
|
65
|
-
|
|
66
|
-
## トラブルシューティング
|
|
67
|
-
|
|
68
|
-
### 認証エラー
|
|
69
|
-
`.env` の `ATLASSIAN_API_TOKEN` を確認してください。
|
|
70
|
-
|
|
71
|
-
### ページが見つからない
|
|
72
|
-
Confluence スペースキー(PRD)が正しいか確認してください。
|
|
73
|
-
|
|
74
|
-
### Markdown変換エラー
|
|
75
|
-
Markdown形式が正しいか確認してください。
|
|
76
|
-
|