moai-adk 0.5.6__py3-none-any.whl → 0.6.0__py3-none-any.whl
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.
Potentially problematic release.
This version of moai-adk might be problematic. Click here for more details.
- moai_adk/__main__.py +1 -1
- moai_adk/core/project/phase_executor.py +4 -1
- moai_adk/templates/.claude/commands/alfred/1-plan.md +13 -13
- moai_adk/templates/.github/ISSUE_TEMPLATE/spec.yml +176 -0
- moai_adk/templates/.github/workflows/spec-issue-sync.yml +167 -0
- moai_adk/templates/.moai/memory/CONFIG-SCHEMA.md +444 -0
- moai_adk/templates/.moai/memory/gitflow-protection-policy.md +220 -0
- moai_adk/templates/.moai/memory/spec-metadata.md +356 -0
- {moai_adk-0.5.6.dist-info → moai_adk-0.6.0.dist-info}/METADATA +115 -2
- {moai_adk-0.5.6.dist-info → moai_adk-0.6.0.dist-info}/RECORD +13 -8
- {moai_adk-0.5.6.dist-info → moai_adk-0.6.0.dist-info}/WHEEL +0 -0
- {moai_adk-0.5.6.dist-info → moai_adk-0.6.0.dist-info}/entry_points.txt +0 -0
- {moai_adk-0.5.6.dist-info → moai_adk-0.6.0.dist-info}/licenses/LICENSE +0 -0
|
@@ -0,0 +1,356 @@
|
|
|
1
|
+
# SPEC Metadata Structure Guide
|
|
2
|
+
|
|
3
|
+
> **MoAI-ADK SPEC Metadata Standard**
|
|
4
|
+
>
|
|
5
|
+
> Every SPEC document must follow this structure.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 📋 Metadata Overview
|
|
10
|
+
|
|
11
|
+
SPEC metadata contains **7 required fields** and **9 optional fields**.
|
|
12
|
+
|
|
13
|
+
### Full Example
|
|
14
|
+
|
|
15
|
+
```yaml
|
|
16
|
+
---
|
|
17
|
+
# Required Fields (7)
|
|
18
|
+
id: AUTH-001 # Unique SPEC ID
|
|
19
|
+
version: 0.0.1 # Semantic version (v0.0.1 = INITIAL, draft start)
|
|
20
|
+
status: draft # draft|active|completed|deprecated
|
|
21
|
+
created: 2025-09-15 # Creation date (YYYY-MM-DD)
|
|
22
|
+
updated: 2025-09-15 # Last updated (YYYY-MM-DD; initially same as created)
|
|
23
|
+
author: @Goos # Author (single GitHub handle)
|
|
24
|
+
priority: high # low|medium|high|critical
|
|
25
|
+
|
|
26
|
+
# Optional Fields – Classification/Meta
|
|
27
|
+
category: security # feature|bugfix|refactor|security|docs|perf
|
|
28
|
+
labels: # Tags for search and grouping
|
|
29
|
+
- authentication
|
|
30
|
+
- jwt
|
|
31
|
+
|
|
32
|
+
# Optional Fields – Relationships (Dependency Graph)
|
|
33
|
+
depends_on: # SPECs this one depends on (optional)
|
|
34
|
+
- USER-001
|
|
35
|
+
blocks: # SPECs blocked by this one (optional)
|
|
36
|
+
- AUTH-002
|
|
37
|
+
related_specs: # Related SPECs (optional)
|
|
38
|
+
- TOKEN-002
|
|
39
|
+
related_issue: "https://github.com/modu-ai/moai-adk/issues/123"
|
|
40
|
+
|
|
41
|
+
# Optional Fields – Scope/Impact
|
|
42
|
+
scope:
|
|
43
|
+
packages: # Impacted packages
|
|
44
|
+
- src/core/auth
|
|
45
|
+
files: # Key files (optional)
|
|
46
|
+
- auth-service.ts
|
|
47
|
+
- jwt-manager.ts
|
|
48
|
+
---
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## Required Fields
|
|
54
|
+
|
|
55
|
+
### 1. `id` – Unique SPEC Identifier
|
|
56
|
+
- **Type**: string
|
|
57
|
+
- **Format**: `<DOMAIN>-<NUMBER>`
|
|
58
|
+
- **Examples**: `AUTH-001`, `INSTALLER-SEC-001`
|
|
59
|
+
- **Rules**:
|
|
60
|
+
- Immutable once assigned
|
|
61
|
+
- Use three digits (001–999)
|
|
62
|
+
- Domain in uppercase; hyphens allowed
|
|
63
|
+
- Directory name: `.moai/specs/SPEC-{ID}/` (e.g., `.moai/specs/SPEC-AUTH-001/`)
|
|
64
|
+
|
|
65
|
+
### 2. `version` – Semantic Version
|
|
66
|
+
- **Type**: string (`MAJOR.MINOR.PATCH`)
|
|
67
|
+
- **Default**: `0.0.1` (all SPECs start here, status: draft)
|
|
68
|
+
- **Version Lifecycle**:
|
|
69
|
+
- **v0.0.1**: INITIAL – SPEC first draft (status: draft)
|
|
70
|
+
- **v0.0.x**: Draft refinements (increment PATCH when editing the SPEC)
|
|
71
|
+
- **v0.1.0**: TDD implementation complete (status: completed, updated via `/alfred:3-sync`)
|
|
72
|
+
- **v0.1.x**: Bug fixes or doc improvements (PATCH increment)
|
|
73
|
+
- **v0.x.0**: Feature additions or major enhancements (MINOR increment)
|
|
74
|
+
- **v1.0.0**: Stable release (production ready, explicit stakeholder approval required)
|
|
75
|
+
|
|
76
|
+
### 3. `status` – Progress State
|
|
77
|
+
- **Type**: enum
|
|
78
|
+
- **Values**:
|
|
79
|
+
- `draft`: Authoring in progress
|
|
80
|
+
- `active`: Implementation underway
|
|
81
|
+
- `completed`: Implementation finished
|
|
82
|
+
- `deprecated`: Planned for retirement
|
|
83
|
+
|
|
84
|
+
### 4. `created` – Creation Date
|
|
85
|
+
- **Type**: date string
|
|
86
|
+
- **Format**: `YYYY-MM-DD`
|
|
87
|
+
- **Example**: `2025-10-06`
|
|
88
|
+
|
|
89
|
+
### 5. `updated` – Last Modified Date
|
|
90
|
+
- **Type**: date string
|
|
91
|
+
- **Format**: `YYYY-MM-DD`
|
|
92
|
+
- **Rule**: Update whenever the SPEC content changes.
|
|
93
|
+
|
|
94
|
+
### 6. `author` – Primary Author
|
|
95
|
+
- **Type**: string
|
|
96
|
+
- **Format**: `@{GitHub ID}`
|
|
97
|
+
- **Example**: `@Goos`
|
|
98
|
+
- **Rules**:
|
|
99
|
+
- Single value only (no `authors` array)
|
|
100
|
+
- Prefix the GitHub handle with `@`
|
|
101
|
+
- Additional contributors belong in the HISTORY section
|
|
102
|
+
|
|
103
|
+
### 7. `priority` – Work Priority
|
|
104
|
+
- **Type**: enum
|
|
105
|
+
- **Values**:
|
|
106
|
+
- `critical`: Immediate attention (security, severe defects)
|
|
107
|
+
- `high`: Major feature work
|
|
108
|
+
- `medium`: Enhancements
|
|
109
|
+
- `low`: Optimizations or documentation
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## Optional Fields
|
|
114
|
+
|
|
115
|
+
### Classification / Meta
|
|
116
|
+
|
|
117
|
+
#### 8. `category` – Change Type
|
|
118
|
+
- **Type**: enum
|
|
119
|
+
- **Values**:
|
|
120
|
+
- `feature`: New functionality
|
|
121
|
+
- `bugfix`: Defect resolution
|
|
122
|
+
- `refactor`: Structural improvements
|
|
123
|
+
- `security`: Security enhancements
|
|
124
|
+
- `docs`: Documentation updates
|
|
125
|
+
- `perf`: Performance optimizations
|
|
126
|
+
|
|
127
|
+
#### 9. `labels` – Classification Tags
|
|
128
|
+
- **Type**: array of strings
|
|
129
|
+
- **Purpose**: Search, filtering, grouping
|
|
130
|
+
- **Example**:
|
|
131
|
+
```yaml
|
|
132
|
+
labels:
|
|
133
|
+
- installer
|
|
134
|
+
- template
|
|
135
|
+
- security
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Relationship Fields (Dependency Graph)
|
|
139
|
+
|
|
140
|
+
#### 10. `depends_on` – Required SPECs
|
|
141
|
+
- **Type**: array of strings
|
|
142
|
+
- **Meaning**: SPECs that must be completed first
|
|
143
|
+
- **Example**:
|
|
144
|
+
```yaml
|
|
145
|
+
depends_on:
|
|
146
|
+
- USER-001
|
|
147
|
+
- AUTH-001
|
|
148
|
+
```
|
|
149
|
+
- **Use Case**: Determines execution order and parallelization.
|
|
150
|
+
|
|
151
|
+
#### 11. `blocks` – Blocked SPECs
|
|
152
|
+
- **Type**: array of strings
|
|
153
|
+
- **Meaning**: SPECs that cannot proceed until this one is resolved
|
|
154
|
+
- **Example**:
|
|
155
|
+
```yaml
|
|
156
|
+
blocks:
|
|
157
|
+
- PAYMENT-003
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
#### 12. `related_specs` – Associated SPECs
|
|
161
|
+
- **Type**: array of strings
|
|
162
|
+
- **Meaning**: Related items without direct dependencies
|
|
163
|
+
- **Example**:
|
|
164
|
+
```yaml
|
|
165
|
+
related_specs:
|
|
166
|
+
- TOKEN-002
|
|
167
|
+
- SESSION-001
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
#### 13. `related_issue` – Linked GitHub Issue
|
|
171
|
+
- **Type**: string (URL)
|
|
172
|
+
- **Format**: Full GitHub issue URL
|
|
173
|
+
- **Example**:
|
|
174
|
+
```yaml
|
|
175
|
+
related_issue: "https://github.com/modu-ai/moai-adk/issues/123"
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
### Scope Fields (Impact Analysis)
|
|
179
|
+
|
|
180
|
+
#### 14. `scope.packages` – Impacted Packages
|
|
181
|
+
- **Type**: array of strings
|
|
182
|
+
- **Meaning**: Packages or modules touched by the SPEC
|
|
183
|
+
- **Example**:
|
|
184
|
+
```yaml
|
|
185
|
+
scope:
|
|
186
|
+
packages:
|
|
187
|
+
- moai-adk-ts/src/core/installer
|
|
188
|
+
- moai-adk-ts/src/core/git
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
#### 15. `scope.files` – Key Files
|
|
192
|
+
- **Type**: array of strings
|
|
193
|
+
- **Meaning**: Primary files involved (for reference)
|
|
194
|
+
- **Example**:
|
|
195
|
+
```yaml
|
|
196
|
+
scope:
|
|
197
|
+
files:
|
|
198
|
+
- template-processor.ts
|
|
199
|
+
- template-security.ts
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
---
|
|
203
|
+
|
|
204
|
+
## Metadata Validation
|
|
205
|
+
|
|
206
|
+
### Required Field Checks
|
|
207
|
+
```bash
|
|
208
|
+
# Verify that every SPEC includes the required fields
|
|
209
|
+
rg "^(id|version|status|created|updated|author|priority):" .moai/specs/SPEC-*/spec.md
|
|
210
|
+
|
|
211
|
+
# Identify SPECs missing the priority field
|
|
212
|
+
rg -L "^priority:" .moai/specs/SPEC-*/spec.md
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### Format Checks
|
|
216
|
+
```bash
|
|
217
|
+
# Ensure the author field uses @Handle format
|
|
218
|
+
rg "^author: @[A-Z]" .moai/specs/SPEC-*/spec.md
|
|
219
|
+
|
|
220
|
+
# Ensure the version field follows 0.x.y
|
|
221
|
+
rg "^version: 0\.\d+\.\d+" .moai/specs/SPEC-*/spec.md
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
---
|
|
225
|
+
|
|
226
|
+
## Migration Guide
|
|
227
|
+
|
|
228
|
+
### Updating Existing SPECs
|
|
229
|
+
|
|
230
|
+
#### 1. Add the `priority` Field
|
|
231
|
+
Add it if missing:
|
|
232
|
+
```yaml
|
|
233
|
+
priority: medium # or low|high|critical
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
#### 2. Normalize the `author` Field
|
|
237
|
+
- `authors: ["@goos"]` → `author: @Goos`
|
|
238
|
+
- Convert lowercase handles to the canonical casing.
|
|
239
|
+
|
|
240
|
+
#### 3. Add Optional Fields (Recommended)
|
|
241
|
+
```yaml
|
|
242
|
+
category: refactor
|
|
243
|
+
labels:
|
|
244
|
+
- code-quality
|
|
245
|
+
- maintenance
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
### Updating config.json for Language Support (v0.4.2+)
|
|
249
|
+
|
|
250
|
+
**Background**: MoAI-ADK v0.4.2 introduces conversation language selection in `/alfred:0-project`. Existing projects need to add language metadata to `.moai/config.json`.
|
|
251
|
+
|
|
252
|
+
#### Migration Steps
|
|
253
|
+
|
|
254
|
+
**For Existing Projects** (before v0.4.2):
|
|
255
|
+
|
|
256
|
+
Current config.json structure:
|
|
257
|
+
```json
|
|
258
|
+
{
|
|
259
|
+
"project": {
|
|
260
|
+
"locale": "en",
|
|
261
|
+
"mode": "personal",
|
|
262
|
+
"language": "python"
|
|
263
|
+
}
|
|
264
|
+
}
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
**Updated Structure** (v0.4.2+):
|
|
268
|
+
```json
|
|
269
|
+
{
|
|
270
|
+
"project": {
|
|
271
|
+
"locale": "en",
|
|
272
|
+
"mode": "personal",
|
|
273
|
+
"language": "python",
|
|
274
|
+
"conversation_language": "en",
|
|
275
|
+
"conversation_language_name": "English",
|
|
276
|
+
"codebase_languages": ["python"]
|
|
277
|
+
}
|
|
278
|
+
}
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
#### New Fields
|
|
282
|
+
|
|
283
|
+
| Field | Type | Required | Description | Example |
|
|
284
|
+
|-------|------|----------|-------------|---------|
|
|
285
|
+
| `conversation_language` | string (ISO 639-1 code) | ✅ Yes | Two-letter language code for Alfred dialogs | `"ko"`, `"en"`, `"ja"`, `"zh"` |
|
|
286
|
+
| `conversation_language_name` | string | ✅ Yes | Display name of conversation language | `"Korean"`, `"English"` |
|
|
287
|
+
| `codebase_languages` | array of strings | ✅ Yes | List of programming languages detected | `["python"]`, `["typescript", "python"]` |
|
|
288
|
+
|
|
289
|
+
#### Manual Update Process
|
|
290
|
+
|
|
291
|
+
1. Open `.moai/config.json`
|
|
292
|
+
2. Add the three new fields under `project`:
|
|
293
|
+
```json
|
|
294
|
+
"conversation_language": "en",
|
|
295
|
+
"conversation_language_name": "English",
|
|
296
|
+
"codebase_languages": ["python"]
|
|
297
|
+
```
|
|
298
|
+
3. Save and commit:
|
|
299
|
+
```bash
|
|
300
|
+
git add .moai/config.json
|
|
301
|
+
git commit -m "chore: add language metadata to config.json for v0.4.2+"
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
#### Automated Update (via `/alfred:0-project`)
|
|
305
|
+
|
|
306
|
+
Running `/alfred:0-project` on an existing project will:
|
|
307
|
+
1. Detect current language settings
|
|
308
|
+
2. Add new fields automatically
|
|
309
|
+
3. Preserve existing values
|
|
310
|
+
|
|
311
|
+
**No manual action required if running `/alfred:0-project` after upgrade.**
|
|
312
|
+
|
|
313
|
+
#### Field Mapping (Legacy → New)
|
|
314
|
+
|
|
315
|
+
| Old Field | New Field | Migration Rule |
|
|
316
|
+
|-----------|-----------|-----------------|
|
|
317
|
+
| `locale` | `conversation_language` | Keep as-is (or run `/alfred:0-project` to re-select) |
|
|
318
|
+
| (none) | `conversation_language_name` | Auto-populate from locale mapping |
|
|
319
|
+
| `language` | `codebase_languages` | Wrap in array: `"python"` → `["python"]` |
|
|
320
|
+
|
|
321
|
+
#### Backward Compatibility
|
|
322
|
+
|
|
323
|
+
- ✅ Projects without new fields will continue working
|
|
324
|
+
- ⚠️ New language features (multilingual documentation) unavailable without migration
|
|
325
|
+
- ✅ `/alfred:0-project` automatically migrates on next run
|
|
326
|
+
- ✅ Auto-detection will prefer new fields if present
|
|
327
|
+
|
|
328
|
+
---
|
|
329
|
+
|
|
330
|
+
## Design Principles
|
|
331
|
+
|
|
332
|
+
### 1. DRY (Don't Repeat Yourself)
|
|
333
|
+
- ❌ **Remove**: the `reference` field (every SPEC referenced the same master plan)
|
|
334
|
+
- ✅ **Instead**: document project-level resources in README.md
|
|
335
|
+
|
|
336
|
+
### 2. Context-Aware
|
|
337
|
+
- Include only the necessary context.
|
|
338
|
+
- Use optional fields only when they add value.
|
|
339
|
+
|
|
340
|
+
### 3. Traceable
|
|
341
|
+
- Use `depends_on`, `blocks`, and `related_specs` to map dependencies.
|
|
342
|
+
- Automated tooling can detect cyclic references.
|
|
343
|
+
|
|
344
|
+
### 4. Maintainable
|
|
345
|
+
- Every field must be machine-verifiable.
|
|
346
|
+
- Maintain consistent formatting for easy parsing.
|
|
347
|
+
|
|
348
|
+
### 5. Simple First
|
|
349
|
+
- Keep complexity low.
|
|
350
|
+
- Limit to 7 required + 9 optional fields.
|
|
351
|
+
- Expand gradually when justified.
|
|
352
|
+
|
|
353
|
+
---
|
|
354
|
+
|
|
355
|
+
**Last Updated**: 2025-10-06
|
|
356
|
+
**Author**: @Alfred
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: moai-adk
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.6.0
|
|
4
4
|
Summary: MoAI Agentic Development Kit - SPEC-First TDD with Alfred SuperAgent & Complete Skills v2.0
|
|
5
5
|
Project-URL: Homepage, https://github.com/modu-ai/moai-adk
|
|
6
6
|
Project-URL: Repository, https://github.com/modu-ai/moai-adk
|
|
@@ -68,7 +68,6 @@ If you've **already installed it and want to understand the concepts**, we recom
|
|
|
68
68
|
| What do Plan/Run/Sync commands do? | [Command Cheat Sheet](#command-cheat-sheet) |
|
|
69
69
|
| What are SPEC, TDD, TAG? | [5 Key Concepts](#5-key-concepts) |
|
|
70
70
|
| Tell me about agents/Skills | [Sub-agents & Skills Overview](#sub-agents--skills-overview) |
|
|
71
|
-
| I want a 4-week hands-on project | [Second Practice: Mini Kanban Board](#second-practice-mini-kanban-board) |
|
|
72
71
|
| Want to dive deeper? | [Additional Resources](#additional-resources) |
|
|
73
72
|
|
|
74
73
|
---
|
|
@@ -629,6 +628,119 @@ graph TD
|
|
|
629
628
|
|
|
630
629
|
---
|
|
631
630
|
|
|
631
|
+
## SPEC GitHub Issue Automation
|
|
632
|
+
|
|
633
|
+
MoAI-ADK now provides **automatic GitHub Issue synchronization** from SPEC documents, seamlessly integrating requirements with issue tracking in team mode.
|
|
634
|
+
|
|
635
|
+
### How It Works
|
|
636
|
+
|
|
637
|
+
When you create a SPEC document using `/alfred:1-plan` and push it to a feature branch:
|
|
638
|
+
|
|
639
|
+
1. **GitHub Actions Workflow** automatically triggers on PR events
|
|
640
|
+
2. **SPEC Metadata** (ID, version, status, priority) is extracted from YAML frontmatter
|
|
641
|
+
3. **GitHub Issue** is created with full SPEC content and metadata table
|
|
642
|
+
4. **PR Comment** is added with a link to the created issue
|
|
643
|
+
5. **Labels** are automatically applied based on priority (critical, high, medium, low)
|
|
644
|
+
|
|
645
|
+
### What Gets Synchronized
|
|
646
|
+
|
|
647
|
+
**From SPEC to GitHub Issue:**
|
|
648
|
+
- **SPEC ID**: Unique identifier (e.g., AUTH-001, USER-001)
|
|
649
|
+
- **Version**: Semantic versioning (v0.1.0, v1.0.0)
|
|
650
|
+
- **Status**: draft, in-review, in-progress, completed, stable
|
|
651
|
+
- **Priority**: critical, high, medium, low (becomes GitHub label)
|
|
652
|
+
- **Full Content**: EARS requirements, acceptance criteria, dependencies
|
|
653
|
+
|
|
654
|
+
**GitHub Issue Format:**
|
|
655
|
+
```markdown
|
|
656
|
+
# [SPEC-AUTH-001] User Authentication (v1.0.0)
|
|
657
|
+
|
|
658
|
+
## SPEC Metadata
|
|
659
|
+
|
|
660
|
+
| Field | Value |
|
|
661
|
+
|-------|-------|
|
|
662
|
+
| **ID** | AUTH-001 |
|
|
663
|
+
| **Version** | v1.0.0 |
|
|
664
|
+
| **Status** | in-progress |
|
|
665
|
+
| **Priority** | high |
|
|
666
|
+
|
|
667
|
+
## SPEC Document
|
|
668
|
+
|
|
669
|
+
[Full SPEC content from .moai/specs/SPEC-AUTH-001/spec.md]
|
|
670
|
+
|
|
671
|
+
---
|
|
672
|
+
|
|
673
|
+
📎 **Branch**: `feature/AUTH-001`
|
|
674
|
+
🔗 **PR**: #123
|
|
675
|
+
📝 **Auto-synced**: This issue is automatically synchronized from the SPEC document
|
|
676
|
+
```
|
|
677
|
+
|
|
678
|
+
### Features
|
|
679
|
+
|
|
680
|
+
✅ **Automatic Issue Creation**: GitHub Issue created on every PR with SPEC file changes
|
|
681
|
+
✅ **Metadata Extraction**: ID, version, status, priority automatically parsed from YAML frontmatter
|
|
682
|
+
✅ **PR Integration**: Issue linked to PR via automatic comment
|
|
683
|
+
✅ **Label Management**: Priority-based labels (critical, high, medium, low) auto-applied
|
|
684
|
+
✅ **CodeRabbit Review** (local only): AI-powered SPEC quality validation in local development
|
|
685
|
+
|
|
686
|
+
### Setup Requirements
|
|
687
|
+
|
|
688
|
+
**GitHub Actions Workflow**: `.github/workflows/spec-issue-sync.yml`
|
|
689
|
+
**GitHub Issue Template**: `.github/ISSUE_TEMPLATE/spec.yml`
|
|
690
|
+
**GitHub Labels**: `spec`, `planning`, `critical`, `high`, `medium`, `low`
|
|
691
|
+
|
|
692
|
+
All templates are automatically installed with MoAI-ADK and synced during `moai-adk init`.
|
|
693
|
+
|
|
694
|
+
### CodeRabbit Integration (Local Only)
|
|
695
|
+
|
|
696
|
+
When working in your **local development environment**, CodeRabbit provides automatic SPEC quality review:
|
|
697
|
+
|
|
698
|
+
**What CodeRabbit Reviews:**
|
|
699
|
+
- ✅ All 7 required metadata fields (id, version, status, created, updated, author, priority)
|
|
700
|
+
- ✅ HISTORY section formatting and chronological order
|
|
701
|
+
- ✅ EARS requirements structure (Ubiquitous, Event-driven, State-driven, Constraints, Optional)
|
|
702
|
+
- ✅ Acceptance criteria in Given-When-Then format
|
|
703
|
+
- ✅ @TAG system compliance for traceability
|
|
704
|
+
|
|
705
|
+
**CodeRabbit Configuration**: `.coderabbit.yaml` (local only, not distributed in packages)
|
|
706
|
+
|
|
707
|
+
> **Note**: CodeRabbit integration is available only in local development environments. Package users receive core GitHub Issue automation without CodeRabbit review.
|
|
708
|
+
|
|
709
|
+
### Workflow Example
|
|
710
|
+
|
|
711
|
+
```bash
|
|
712
|
+
# 1. Create SPEC
|
|
713
|
+
/alfred:1-plan "User authentication feature"
|
|
714
|
+
|
|
715
|
+
# 2. SPEC file created at .moai/specs/SPEC-AUTH-001/spec.md
|
|
716
|
+
# 3. Feature branch created: feature/SPEC-AUTH-001
|
|
717
|
+
# 4. Draft PR created (team mode)
|
|
718
|
+
|
|
719
|
+
# 5. GitHub Actions automatically:
|
|
720
|
+
# - Parses SPEC metadata
|
|
721
|
+
# - Creates GitHub Issue #45
|
|
722
|
+
# - Adds PR comment: "✅ SPEC GitHub Issue Created - Issue: #45"
|
|
723
|
+
# - Applies labels: spec, planning, high
|
|
724
|
+
|
|
725
|
+
# 6. CodeRabbit reviews SPEC (local only):
|
|
726
|
+
# - Validates metadata
|
|
727
|
+
# - Checks EARS requirements
|
|
728
|
+
# - Provides quality score
|
|
729
|
+
|
|
730
|
+
# 7. Continue with TDD implementation
|
|
731
|
+
/alfred:2-run AUTH-001
|
|
732
|
+
```
|
|
733
|
+
|
|
734
|
+
### Benefits
|
|
735
|
+
|
|
736
|
+
1. **Centralized Tracking**: All SPEC requirements tracked as GitHub Issues
|
|
737
|
+
2. **Team Visibility**: Non-technical stakeholders can follow progress via Issues
|
|
738
|
+
3. **Automated Workflow**: No manual issue creation—fully automated from SPEC to Issue
|
|
739
|
+
4. **Traceability**: Direct link between SPEC files, Issues, PRs, and implementation
|
|
740
|
+
5. **Quality Assurance**: CodeRabbit validates SPEC quality before implementation (local only)
|
|
741
|
+
|
|
742
|
+
---
|
|
743
|
+
|
|
632
744
|
## 5 Key Concepts
|
|
633
745
|
|
|
634
746
|
MoAI-ADK consists of 5 key concepts. Each concept connects to the others, and together they create a powerful development system.
|
|
@@ -1467,6 +1579,7 @@ If you need to temporarily disable hooks, edit `.claude/settings.json`:
|
|
|
1467
1579
|
|
|
1468
1580
|
| Version | Key Features | Date |
|
|
1469
1581
|
| ----------- | ------------------------------------------------------------------------------------------------ | ---------- |
|
|
1582
|
+
| **v0.5.7** | 🎯 SPEC → GitHub Issue automation + CodeRabbit integration + Auto PR comments | 2025-10-27 |
|
|
1470
1583
|
| **v0.4.11** | ✨ TAG Guard system + CLAUDE.md formatting improvements + Code cleanup | 2025-10-23 |
|
|
1471
1584
|
| **v0.4.10** | 🔧 Hook robustness improvements + Bilingual documentation + Template language config | 2025-10-23 |
|
|
1472
1585
|
| **v0.4.9** | 🎯 Hook JSON schema validation fixes + Comprehensive tests (468/468 passing) | 2025-10-23 |
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
moai_adk/__init__.py,sha256=8E7tMBsxNR-EFqDY241RCJlSZEdCSigIbek2CiOzMBs,359
|
|
2
|
-
moai_adk/__main__.py,sha256=
|
|
2
|
+
moai_adk/__main__.py,sha256=uo6p-EzHYCetlU3gGxGasiIkwGq6wlzag7RYtzieoJI,2421
|
|
3
3
|
moai_adk/cli/__init__.py,sha256=tidIaJnd4Pje_5QYRq7OvRRst4T3kaPlkw5QcPQ3l1Y,135
|
|
4
4
|
moai_adk/cli/main.py,sha256=mHACHi27AP2N7fg7zhzOo1tlF1Jrlw1_AcbxMfpGLVE,306
|
|
5
5
|
moai_adk/cli/commands/__init__.py,sha256=TrAIWcJRGXh1mY8itSzWm-W0nnybzQIFOuh6oksKWO0,680
|
|
@@ -25,7 +25,7 @@ moai_adk/core/project/backup_utils.py,sha256=-zEXIhGsM-MdX1voUIpKxLlR57Y-lqLEZSi
|
|
|
25
25
|
moai_adk/core/project/checker.py,sha256=B94mGLHDZkjQnFDgV8sknJDms5oIiHeyKcgxWI87-f8,9523
|
|
26
26
|
moai_adk/core/project/detector.py,sha256=ADVg36yvyqJEPQVNc_x9iInF9dzi7YZqqXfDq2XL17Q,4230
|
|
27
27
|
moai_adk/core/project/initializer.py,sha256=yqxePuCO2ednzCOpDZLczyCP079J6Io4pvtynTp4J6w,6724
|
|
28
|
-
moai_adk/core/project/phase_executor.py,sha256=
|
|
28
|
+
moai_adk/core/project/phase_executor.py,sha256=w3z8VRT9p9rcmMt2lWCHmH5rHSWmLMvbe1dHHMEu0KY,10666
|
|
29
29
|
moai_adk/core/project/validator.py,sha256=gH9ywTMQTwqtqBVrMWj5_bPYFrVzjHuFoU4QdeVa1O4,5756
|
|
30
30
|
moai_adk/core/quality/__init__.py,sha256=_uNsbThBLmVLWZCPmEgfFyQqJx3tdef9jhkP9QoHuJY,222
|
|
31
31
|
moai_adk/core/quality/trust_checker.py,sha256=CN067AiublAH46IBAKEV_I-8Wc0bNaR2dMnMf9n5oBg,15198
|
|
@@ -54,7 +54,7 @@ moai_adk/templates/.claude/agents/alfred/tag-agent.md,sha256=ocDVfqk1q7f8SH7As3X
|
|
|
54
54
|
moai_adk/templates/.claude/agents/alfred/tdd-implementer.md,sha256=vCyJRZWdRXPk9qdra-QQtEf21ap28w8sx5VYPnWMHMA,10200
|
|
55
55
|
moai_adk/templates/.claude/agents/alfred/trust-checker.md,sha256=oTQ6BvGYU_luJDNwqjNPIU9G5dKUWRV4wJpmgyqr4dk,13578
|
|
56
56
|
moai_adk/templates/.claude/commands/alfred/0-project.md,sha256=-gyBdhT7dYIGMNYv91DF_1uepGW_B0lJMDV8nlrzuIE,45878
|
|
57
|
-
moai_adk/templates/.claude/commands/alfred/1-plan.md,sha256=
|
|
57
|
+
moai_adk/templates/.claude/commands/alfred/1-plan.md,sha256=t_6ubTvlZsp8u1RIy5isJFlITH7tFp2UKiIg0NfJ4bU,22028
|
|
58
58
|
moai_adk/templates/.claude/commands/alfred/2-run.md,sha256=m2WLbrR0Njky5SPMLTuvQPJBeSUcmlUXivr4IbvKUYA,20415
|
|
59
59
|
moai_adk/templates/.claude/commands/alfred/3-sync.md,sha256=yhxi-V7NOkhRYcrNKQ4zYJGxHrtQTfRm_ejcExf-SsE,22402
|
|
60
60
|
moai_adk/templates/.claude/hooks/alfred/HOOK_SCHEMA_VALIDATION.md,sha256=5dd6KRFQXzp0L8lAWKRN7Momgg_8XNV1QZ6VGs03_pc,9064
|
|
@@ -252,24 +252,29 @@ moai_adk/templates/.claude/skills/moai-spec-authoring/examples.md,sha256=k-3QWf6
|
|
|
252
252
|
moai_adk/templates/.claude/skills/moai-spec-authoring/reference.md,sha256=Wbz1GM8nN64D7X49I0TffQPKxtUPWWmhOcaf_Ci0ZSA,16624
|
|
253
253
|
moai_adk/templates/.claude/skills/moai-spec-authoring/examples/validate-spec.sh,sha256=QzwhuMnNK2itb6DLI_htqA4l_EHSgO0FG2pikV7I-ME,4241
|
|
254
254
|
moai_adk/templates/.github/PULL_REQUEST_TEMPLATE.md,sha256=q753rSPFZfylgwh6HkEP2ggEqB9qK-VnoLuXTxueTzw,2146
|
|
255
|
+
moai_adk/templates/.github/ISSUE_TEMPLATE/spec.yml,sha256=c6WaTy7Vh6IsNsIJzSTGuGpaGhZAZ1prQXGIUM7P8PA,5212
|
|
255
256
|
moai_adk/templates/.github/workflows/moai-gitflow.yml,sha256=D9ob1O7tzsUvk3WQPPaHFx1Oo6_RxnbCb5WHJ6DWyrI,8589
|
|
257
|
+
moai_adk/templates/.github/workflows/spec-issue-sync.yml,sha256=VJ0IQcIEnlnZ-3jdvQNruhBxpygYRZAP2bkn35CCO-Q,6307
|
|
256
258
|
moai_adk/templates/.moai/config.json,sha256=0DZ9zK3wUD2lRfeqX93tYJz5Pb_h7DV4k2wyB9RZ6HQ,2202
|
|
257
259
|
moai_adk/templates/.moai/memory/CLAUDE-AGENTS-GUIDE.md,sha256=37Qj5DYcyUniLM1g8IU7UWFI_16tutZrcAkJc4E5i20,15876
|
|
258
260
|
moai_adk/templates/.moai/memory/CLAUDE-PRACTICES.md,sha256=Tf3q68X1DiA3MkIBYu7AMXoeparYrDRpyqVI5Nw92OY,12653
|
|
259
261
|
moai_adk/templates/.moai/memory/CLAUDE-RULES.md,sha256=S9GODGRzwwleOmROVtBDa471Ok5NyQLWIkaO_4peHhU,19783
|
|
262
|
+
moai_adk/templates/.moai/memory/CONFIG-SCHEMA.md,sha256=XmvogEnGedRItVc9OABKr4lDNEZhcKZQ3Qa6KlfxE3E,12477
|
|
260
263
|
moai_adk/templates/.moai/memory/DEVELOPMENT-GUIDE.md,sha256=SAcue1J5-DEJpygDnTgp_ex-ok2E4lbcykBuBiC7tGs,14534
|
|
261
264
|
moai_adk/templates/.moai/memory/GITFLOW-PROTECTION-POLICY.md,sha256=tm2ZOmNMvomAhh4_AGTUNjmSsc-eKzo1SGshojx2QL0,6228
|
|
262
265
|
moai_adk/templates/.moai/memory/SKILLS-DESCRIPTION-POLICY.md,sha256=uMEFi6uojnpO_MGGtwhakYQzVF2yzVV9ZzfQe5tB0Hk,7823
|
|
263
266
|
moai_adk/templates/.moai/memory/SPEC-METADATA.md,sha256=Ha4ATMxyH2PgQdVbS1fYwVH0PnIkfqk4hfuB5ksMFFk,9702
|
|
264
267
|
moai_adk/templates/.moai/memory/config-schema.md,sha256=XmvogEnGedRItVc9OABKr4lDNEZhcKZQ3Qa6KlfxE3E,12477
|
|
268
|
+
moai_adk/templates/.moai/memory/gitflow-protection-policy.md,sha256=tm2ZOmNMvomAhh4_AGTUNjmSsc-eKzo1SGshojx2QL0,6228
|
|
269
|
+
moai_adk/templates/.moai/memory/spec-metadata.md,sha256=Ha4ATMxyH2PgQdVbS1fYwVH0PnIkfqk4hfuB5ksMFFk,9702
|
|
265
270
|
moai_adk/templates/.moai/project/product.md,sha256=IrRSqhu0o5KNfn453DUWoUKzdoO3m6013iYCwaHYCxM,5166
|
|
266
271
|
moai_adk/templates/.moai/project/structure.md,sha256=YWZ4ggmfzveKx8SQGFQWXdDUh5mxOLkEyy5yVdR3Rn0,4791
|
|
267
272
|
moai_adk/templates/.moai/project/tech.md,sha256=REecMv8wOvutt-pQZ5nlGk5YdReTan7AHcKJ2Yes6RM,5758
|
|
268
273
|
moai_adk/utils/__init__.py,sha256=VnVfQzzKHvKw4bNdEw5xdscnRQYFrnr-v_TOBr3naPs,225
|
|
269
274
|
moai_adk/utils/banner.py,sha256=znppKd5yo-tTqgyhgPVJjstrTrfcy_v3X1_RFQxP4Fk,1878
|
|
270
275
|
moai_adk/utils/logger.py,sha256=g-m07PGKjK2bKRIInfSn6m-024Bedai-pV_WjZKDeu8,5064
|
|
271
|
-
moai_adk-0.
|
|
272
|
-
moai_adk-0.
|
|
273
|
-
moai_adk-0.
|
|
274
|
-
moai_adk-0.
|
|
275
|
-
moai_adk-0.
|
|
276
|
+
moai_adk-0.6.0.dist-info/METADATA,sha256=MV0-U3Rcq-1ArFRCCGKQ35tIKAs2ugnefEwGrQ6vWac,67983
|
|
277
|
+
moai_adk-0.6.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
|
|
278
|
+
moai_adk-0.6.0.dist-info/entry_points.txt,sha256=P9no1794UipqH72LP-ltdyfVd_MeB1WKJY_6-JQgV3U,52
|
|
279
|
+
moai_adk-0.6.0.dist-info/licenses/LICENSE,sha256=M1M2b07fWcSWRM6_P3wbZKndZvyfHyYk_Wu9bS8F7o8,1069
|
|
280
|
+
moai_adk-0.6.0.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|
|
File without changes
|