@relipa/ai-flow-kit 0.1.5-beta.0 → 0.1.5
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/custom/rules/project-conventions.md +67 -51
- package/custom/skills/gate-review/SKILL.md +1 -1
- package/custom/skills/generate-spec/SKILL.md +99 -99
- package/custom/skills/read-study-requirement/SKILL.md +7 -5
- package/custom/skills/review-plan/SKILL.md +194 -194
- package/custom/templates/shared/coding-workflow.md +0 -0
- package/custom/templates/shared/create-testcase-workflow.md +21 -9
- package/custom/templates/shared/gate-workflow.md +61 -8
- package/custom/templates/tools/claude.md +13 -13
- package/custom/templates/tools/copilot.md +12 -12
- package/custom/templates/tools/cursor.md +12 -12
- package/custom/templates/tools/gemini.md +22 -22
- package/custom/templates/tools/generic.md +17 -17
- package/docs/common/AIFLOW.md +10 -10
- package/docs/common/CHANGELOG.md +16 -0
- package/docs/common/ai-integration.md +53 -53
- package/docs/common/workflows/bug-fix.md +126 -126
- package/docs/common/workflows/feature.md +123 -123
- package/package.json +1 -1
- package/scripts/docs-repo.js +49 -0
- package/scripts/hooks/session-start.js +9 -5
- package/scripts/init.js +4 -1
- package/scripts/link-resolver.js +0 -0
- package/scripts/prompt.js +11 -11
- package/scripts/task.js +70 -22
- package/scripts/update.js +4 -0
- package/scripts/use.js +0 -0
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
# Cursor AI Project Rules
|
|
2
|
-
|
|
3
|
-
You are an expert AI assistant specialized in this project's stack. Follow the Gate Workflow and Team Rules strictly.
|
|
4
|
-
|
|
5
|
-
> **Important:** Always check `.aiflow/context/current.json` and the `
|
|
6
|
-
|
|
7
|
-
If Gate 1 doesn't auto-start, wait for the developer to type **"start"**, **"Gate 1"** or **"Analyze ticket"**.
|
|
8
|
-
|
|
9
|
-
## Interaction Rules:
|
|
10
|
-
- **COLLABORATIVE SKILLS:** When a skill (like `read-study-requirement`) says to "ask one question at a time", you MUST stop and wait for the developer's reply before proceeding.
|
|
11
|
-
- **NEVER BATCH QUESTIONS:** Only ask one question per message.
|
|
12
|
-
- **WAIT FOR APPROVAL:** Do not move to the next Gate until you receive "APPROVED".
|
|
1
|
+
# Cursor AI Project Rules
|
|
2
|
+
|
|
3
|
+
You are an expert AI assistant specialized in this project's stack. Follow the Gate Workflow and Team Rules strictly.
|
|
4
|
+
|
|
5
|
+
> **Important:** Always check `.aiflow/context/current.json` and the `AK-Docs/04.Coding/` docs directory before starting any task to understand current context and progress.
|
|
6
|
+
|
|
7
|
+
If Gate 1 doesn't auto-start, wait for the developer to type **"start"**, **"Gate 1"** or **"Analyze ticket"**.
|
|
8
|
+
|
|
9
|
+
## Interaction Rules:
|
|
10
|
+
- **COLLABORATIVE SKILLS:** When a skill (like `read-study-requirement`) says to "ask one question at a time", you MUST stop and wait for the developer's reply before proceeding.
|
|
11
|
+
- **NEVER BATCH QUESTIONS:** Only ask one question per message.
|
|
12
|
+
- **WAIT FOR APPROVAL:** Do not move to the next Gate until you receive "APPROVED".
|
|
@@ -1,22 +1,22 @@
|
|
|
1
|
-
# Gemini AI System Instructions
|
|
2
|
-
|
|
3
|
-
You are an expert AI assistant specialized in this project's stack. Follow the Gate Workflow and Team Rules strictly.
|
|
4
|
-
|
|
5
|
-
> **Important:** When starting a session, always read `.aiflow/context/current.json` to load ticket context and check the `
|
|
6
|
-
|
|
7
|
-
If no instructions are automatically followed, wait for the developer to type **"start"** or **"Gate 1"** to start the analysis.
|
|
8
|
-
|
|
9
|
-
## Interaction Rules:
|
|
10
|
-
- **COLLABORATIVE SKILLS:** When a skill (like `read-study-requirement`) says to "ask one question at a time", you MUST stop and wait for the developer's reply before proceeding.
|
|
11
|
-
- **NEVER BATCH QUESTIONS:** Only ask one question per message.
|
|
12
|
-
- **WAIT FOR APPROVAL:** Do not move to the next Gate until you receive "APPROVED".
|
|
13
|
-
- **PROJECT CONVENTIONS:** Before writing any output file (plan, requirement, summary), read `custom/rules/project-conventions.md`. These rules override upstream skill defaults.
|
|
14
|
-
|
|
15
|
-
## Telemetry Command (detect once, use everywhere)
|
|
16
|
-
|
|
17
|
-
Before the first gate, run this to detect the correct `ak` command for your environment:
|
|
18
|
-
```bash
|
|
19
|
-
command -v ak >/dev/null 2>&1 && echo "USE: ak" || echo "USE: ak.cmd"
|
|
20
|
-
```
|
|
21
|
-
Use whichever prints (e.g. `ak` on native Linux/Mac/Windows, `ak.cmd` on WSL without ak installed).
|
|
22
|
-
All `ak gate ...` examples below assume the detected command. Substitute accordingly.
|
|
1
|
+
# Gemini AI System Instructions
|
|
2
|
+
|
|
3
|
+
You are an expert AI assistant specialized in this project's stack. Follow the Gate Workflow and Team Rules strictly.
|
|
4
|
+
|
|
5
|
+
> **Important:** When starting a session, always read `.aiflow/context/current.json` to load ticket context and check the `AK-Docs/04.Coding/` docs directory for existing progress.
|
|
6
|
+
|
|
7
|
+
If no instructions are automatically followed, wait for the developer to type **"start"** or **"Gate 1"** to start the analysis.
|
|
8
|
+
|
|
9
|
+
## Interaction Rules:
|
|
10
|
+
- **COLLABORATIVE SKILLS:** When a skill (like `read-study-requirement`) says to "ask one question at a time", you MUST stop and wait for the developer's reply before proceeding.
|
|
11
|
+
- **NEVER BATCH QUESTIONS:** Only ask one question per message.
|
|
12
|
+
- **WAIT FOR APPROVAL:** Do not move to the next Gate until you receive "APPROVED".
|
|
13
|
+
- **PROJECT CONVENTIONS:** Before writing any output file (plan, requirement, summary), read `custom/rules/project-conventions.md`. These rules override upstream skill defaults.
|
|
14
|
+
|
|
15
|
+
## Telemetry Command (detect once, use everywhere)
|
|
16
|
+
|
|
17
|
+
Before the first gate, run this to detect the correct `ak` command for your environment:
|
|
18
|
+
```bash
|
|
19
|
+
command -v ak >/dev/null 2>&1 && echo "USE: ak" || echo "USE: ak.cmd"
|
|
20
|
+
```
|
|
21
|
+
Use whichever prints (e.g. `ak` on native Linux/Mac/Windows, `ak.cmd` on WSL without ak installed).
|
|
22
|
+
All `ak gate ...` examples below assume the detected command. Substitute accordingly.
|
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
# AI System Instructions
|
|
2
|
-
|
|
3
|
-
You are an expert AI assistant. Follow the project's Gate Workflow and Team Rules strictly.
|
|
4
|
-
|
|
5
|
-
## Context Awareness
|
|
6
|
-
- **Ticket context**: `.aiflow/context/current.json`
|
|
7
|
-
- **Task progress**: `
|
|
8
|
-
- **Rules**: `.rules/`
|
|
9
|
-
|
|
10
|
-
Follow the gated workflow and rules defined below.
|
|
11
|
-
|
|
12
|
-
If Gate 1 does not start automatically, please start it when the developer types **"Gate 1"**.
|
|
13
|
-
|
|
14
|
-
## Interaction Rules:
|
|
15
|
-
- **COLLABORATIVE SKILLS:** When a skill (like `read-study-requirement`) says to "ask one question at a time", you MUST stop and wait for the developer's reply before proceeding.
|
|
16
|
-
- **NEVER BATCH QUESTIONS:** Only ask one question per message.
|
|
17
|
-
- **WAIT FOR APPROVAL:** Do not move to the next Gate until you receive "APPROVED".
|
|
1
|
+
# AI System Instructions
|
|
2
|
+
|
|
3
|
+
You are an expert AI assistant. Follow the project's Gate Workflow and Team Rules strictly.
|
|
4
|
+
|
|
5
|
+
## Context Awareness
|
|
6
|
+
- **Ticket context**: `.aiflow/context/current.json`
|
|
7
|
+
- **Task progress**: `AK-Docs/04.Coding/<section>/[functionId]/[ticketId].md`
|
|
8
|
+
- **Rules**: `.rules/`
|
|
9
|
+
|
|
10
|
+
Follow the gated workflow and rules defined below.
|
|
11
|
+
|
|
12
|
+
If Gate 1 does not start automatically, please start it when the developer types **"Gate 1"**.
|
|
13
|
+
|
|
14
|
+
## Interaction Rules:
|
|
15
|
+
- **COLLABORATIVE SKILLS:** When a skill (like `read-study-requirement`) says to "ask one question at a time", you MUST stop and wait for the developer's reply before proceeding.
|
|
16
|
+
- **NEVER BATCH QUESTIONS:** Only ask one question per message.
|
|
17
|
+
- **WAIT FOR APPROVAL:** Do not move to the next Gate until you receive "APPROVED".
|
package/docs/common/AIFLOW.md
CHANGED
|
@@ -112,7 +112,7 @@ claude # open Claude → AI auto-starts Gate 1
|
|
|
112
112
|
| 2 | Read `CLAUDE.md` + source code | Understand architecture, tech stack, patterns |
|
|
113
113
|
| 3 | Investigate related files & data flow | Identify affected areas, dependencies |
|
|
114
114
|
| 4 | Ask clarifying questions (one at a time) | Ensure full understanding |
|
|
115
|
-
| 5 | Write `
|
|
115
|
+
| 5 | Write `AK-Docs/04.Coding/01.Requirements/[functionId]/[ticketId].md` | Structured requirement document |
|
|
116
116
|
|
|
117
117
|
**AI asks questions when:**
|
|
118
118
|
- Business requirements are vague or ambiguous
|
|
@@ -121,7 +121,7 @@ claude # open Claude → AI auto-starts Gate 1
|
|
|
121
121
|
- Multiple approaches are possible and need input
|
|
122
122
|
- Impact on existing features is unclear
|
|
123
123
|
|
|
124
|
-
**Requirement Document Output (`
|
|
124
|
+
**Requirement Document Output (`AK-Docs/04.Coding/01.Requirements/[functionId]/[ticketId].md`):**
|
|
125
125
|
|
|
126
126
|
```
|
|
127
127
|
├── 1. Requirements Summary
|
|
@@ -166,13 +166,13 @@ Summary:
|
|
|
166
166
|
- Approach: [brief description]
|
|
167
167
|
- Files affected: [N] files
|
|
168
168
|
|
|
169
|
-
→ Review:
|
|
169
|
+
→ Review: AK-Docs/04.Coding/01.Requirements/[functionId]/[ticketId].md
|
|
170
170
|
→ Type APPROVED to proceed
|
|
171
171
|
→ Or provide feedback to update
|
|
172
172
|
```
|
|
173
173
|
|
|
174
174
|
**Gate 1 Output:**
|
|
175
|
-
- `
|
|
175
|
+
- `AK-Docs/04.Coding/01.Requirements/[functionId]/[ticketId].md` approved by DEV
|
|
176
176
|
- DEV has typed "APPROVED"
|
|
177
177
|
|
|
178
178
|
---
|
|
@@ -265,14 +265,14 @@ In fast mode, AI uses the `tdd-lean` skill instead of per-test TDD to save massi
|
|
|
265
265
|
| 1 | `superpowers:verification-before-completion` | All tests PASS |
|
|
266
266
|
| 2 | `impact-analysis` skill | No breaking changes outside scope |
|
|
267
267
|
| 3 | `custom/rules/review-checklist.md` | All items ticked |
|
|
268
|
-
| 4 | Create `
|
|
268
|
+
| 4 | Create `AK-Docs/04.Coding/04.Reviews/[functionId]/[ticketId].md` | File exists and is complete |
|
|
269
269
|
|
|
270
270
|
**If any step fails → AI fixes it first, without showing DEV.**
|
|
271
271
|
|
|
272
272
|
**Summary report output:**
|
|
273
273
|
|
|
274
274
|
```
|
|
275
|
-
|
|
275
|
+
AK-Docs/04.Coding/04.Reviews/[functionId]/[ticketId].md
|
|
276
276
|
├── List of changed files + reasons
|
|
277
277
|
├── Acceptance Criteria → results (Done/Not Done)
|
|
278
278
|
├── Tests: quantity, coverage
|
|
@@ -287,7 +287,7 @@ plan/[ticket-id]/summary.md
|
|
|
287
287
|
Tests: ✅ [N] passed
|
|
288
288
|
Impact: [Low/Medium/High]
|
|
289
289
|
Checklist: [N/N] ✅
|
|
290
|
-
Summary:
|
|
290
|
+
Summary: AK-Docs/04.Coding/04.Reviews/[functionId]/[ticketId].md
|
|
291
291
|
|
|
292
292
|
Type APPROVED if OK
|
|
293
293
|
Type BUG: [description] if there are issues
|
|
@@ -299,7 +299,7 @@ Type BUG: [description] if there are issues
|
|
|
299
299
|
- `BUG: requirement bug` → AI updates requirement doc → back to Gate 1
|
|
300
300
|
|
|
301
301
|
**Gate 4 Output:**
|
|
302
|
-
- `
|
|
302
|
+
- `AK-Docs/04.Coding/04.Reviews/[functionId]/[ticketId].md` completed
|
|
303
303
|
- DEV has typed "APPROVED"
|
|
304
304
|
|
|
305
305
|
---
|
|
@@ -458,7 +458,7 @@ aiflow telemetry disable # disable tracking
|
|
|
458
458
|
|
|
459
459
|
## Multi-AI Environment Setup
|
|
460
460
|
|
|
461
|
-
One of the core strengths of `ai-flow-kit` is that the **Gate Workflow** is tool-agnostic. Since state is saved in `.aiflow/context/current.json` and the `
|
|
461
|
+
One of the core strengths of `ai-flow-kit` is that the **Gate Workflow** is tool-agnostic. Since state is saved in `.aiflow/context/current.json` and the `AK-Docs/04.Coding/` docs directory, you can switch tools mid-task.
|
|
462
462
|
|
|
463
463
|
### How to Switch Tools
|
|
464
464
|
1. **Analyze (Gate 1)** using Claude Code CLI (great for deep codebase scans).
|
|
@@ -506,7 +506,7 @@ A: Yes. Use `aiflow task pause` to save your current progress, then `aiflow use
|
|
|
506
506
|
**Q: If I resume a task, will Claude know which gate to start at?**
|
|
507
507
|
A: Yes. The SessionStart hook reads `.aiflow/tasks/<taskId>/task-state.json` and injects gate-aware instructions. If Gate 1 was already approved, Claude will skip to Gate 2, and so on.
|
|
508
508
|
**Q: Can I resume a Gate 3 (Code Generation) task in a new chatbox?**
|
|
509
|
-
A: Yes. Gate 3 progress is saved via `[x]` checkboxes in `
|
|
509
|
+
A: Yes. Gate 3 progress is saved via `[x]` checkboxes in `AK-Docs/04.Coding/02.Plans/[functionId]/[ticketId].md`. If you open a new chatbox and say "continue", the AI will automatically skip completed tasks and pick up exactly where it left off.
|
|
510
510
|
|
|
511
511
|
**Q: How does AI estimate effort?**
|
|
512
512
|
A: AI analyzes the scope of changes (files affected, complexity, test requirements) and categorizes: S (< 1h), M (1-4h), L (4-8h), XL (8h+, should split).
|
package/docs/common/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,17 @@ Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
7
7
|
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
+
## [Unreleased]
|
|
11
|
+
|
|
12
|
+
### Fixed
|
|
13
|
+
|
|
14
|
+
- **`aiflow prompt <type>` still emitted `plan/[ticket-id]/...` paths** — The 0.1.5 migration to `04.Coding/` (see below) updated `gate-workflow.md`, the skills, all 5 tool templates, and `session-start.js`, but missed `scripts/prompt.js`. Its `PROMPT_TEMPLATES` (used by `aiflow prompt feature|bug-fix|refactor|investigation|impact-analysis|testing|documentation` to build the copy-paste prompt for Cursor/Gemini/manual use) still hard-coded `Output plan/[ticket-id]/requirement.md` / `plan.md` / `summary.md`, contradicting the `custom/rules/project-conventions.md` override appended later in the same prompt — this was the root cause of `/plan` still appearing at the project root even on 0.1.5-beta.1. All 11 occurrences now point at the current `04.Coding/<section>/[functionId]/[ticketId].md` convention.
|
|
15
|
+
- **`ak init` still gitignored `plan/`** — `ensureAiflowGitignored()` in `scripts/init.js` added `plan/` to `.gitignore` on every init, reinforcing the deprecated convention. Removed; `04.Coding/` output now lives in `AK-Docs/` (see below) and isn't part of the source repo's `.gitignore` concerns.
|
|
16
|
+
|
|
17
|
+
### Changed
|
|
18
|
+
|
|
19
|
+
- **DEV workflow output relocated to `AK-Docs/04.Coding/`** — Per `docs/internal/Project-Structure.md` / `Coding-Structure.md`, `04.Coding/` (and its BA/QA siblings `02.BA-Specs/`, `03.Testing/`, `00.Project-Overview/`) belong under the `AK-Docs/` docs repo (a sibling of the source repo, synced via `scripts/docs-repo.js`), not directly at the source repo root. Updated all references across `CLAUDE.md`, `custom/rules/project-conventions.md`, `custom/templates/shared/gate-workflow.md`, the 5 tool templates, the DEV skills (`read-study-requirement`, `generate-spec`, `review-plan`, `gate-review`), `docs/common/AIFLOW.md` / `ai-integration.md` / `workflows/{bug-fix,feature}.md`, `scripts/hooks/session-start.js`, and `scripts/prompt.js`. `scripts/task.js` now resolves the coding dir via `resolveDocsRepoPath(PROJECT_DIR, 'AK-Docs')` (from `docs-repo.js`) instead of hard-coding the path, so `findTaskDocs()` / `detectCurrentGate()` look under `AK-Docs/04.Coding/` first, with the legacy `plan/<taskId>/` folder (at the source repo root) still checked as a fallback.
|
|
20
|
+
|
|
10
21
|
## [0.1.5] - 2026-07-01
|
|
11
22
|
|
|
12
23
|
### Added
|
|
@@ -14,9 +25,14 @@ Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
14
25
|
- **Brainstorming Skill Integration** — Injected `superpowers:brainstorming` into Gate 1 of the BA Create Spec workflow, allowing the AI to actively clarify and brainstorm raw requirements from the backlog.
|
|
15
26
|
- **Mandatory `functionId` Check** — Enforced mandatory `functionId` checks at Gate 1 of all BA and QA workflows (e.g., `create-spec-workflow.md`, `create-testcase-workflow.md`). If missing in the ticket or backlog description, the AI stops and prompts the user to input the ID.
|
|
16
27
|
- **`/coding` slash command** — New `.claude/commands/coding.md`, installed alongside `/create-spec` and `/create-testcase`. Manually loads `.aiflow/context/current.json` and starts (or resumes) the `[DEV] 5-Gate Development Workflow` for `bug-fix` / `feature` / `refactor` / `investigation` / `documentation` tickets. Fixes a gap where those task types had no slash-command fallback: they relied solely on the `SessionStart` hook's auto-start message, which does not re-fire if a ticket is loaded with `ak use` while a Claude Code chat session is already open — leaving phrases like `"start"` with no effect since the AI was never given the ticket context. `ak use`'s "Next Steps" hint and the `gate-workflow.md` / `session-start.js` auto-start tips now also mention `/coding` as the manual fallback.
|
|
28
|
+
- **DEV workflow `functionId` Pre-flight (Gate 1 — Bước 0)** — The `[DEV] 5-Gate Development Workflow` now runs the same mandatory Pre-flight as the BA/QA workflows before writing any output. `functionId` is project-defined with no enforced format (`F-001_User-Login`, `AD06`, `UC-LOGIN` are all valid) and is resolved in priority order: (1) `functionId`/`screenId` field in `.aiflow/context/current.json`; (2) **inferred from the input** — when the task input includes a BA-delivered UC Spec file, the AI reads its content or its containing folder path (e.g. `02.BA-Specs/04.UC-Specs/[functionId]/`) and can consult `04.Coding/00.Overview/_Index.md` / `00.Project-Overview/Function-List.md`, then asks the DEV to **confirm** the candidate ("functionId của task này có phải là [X] không?"); (3) only when nothing can be inferred does it ask the DEV to provide the ID directly. The workflow MUST NOT continue without a `functionId`.
|
|
17
29
|
|
|
18
30
|
### Changed
|
|
19
31
|
|
|
32
|
+
- **DEV 5-Gate output migration: `plan/[ticket-id]/` → `04.Coding/`** — All coding/documentation task outputs now follow the `Coding-Structure.md` convention: `04.Coding/<section>/[functionId]/[ticketId].md` (folder per feature, file per ticket — one feature spans multiple tickets). Gate mapping: Gate 1 → `01.Requirements/`, Gate 2 → `02.Plans/`, Gate 3 → `03.TDD-Notes/` (new artifact: test list written before code + implementation notes), Gate 4 → `04.Reviews/` (replaces `summary.md`), Gate 5 → `05.Pull-Requests/` (new artifact: PR description with links to UC Spec / Test Case / Dev Plan, pushed to remote before creating the PR). Each gate also updates the `04.Coding/00.Overview/_Index.md` tracker (`F-ID | Ticket | Dev | Gate | PR`). The legacy `plan/[ticket-id]/` convention is deprecated. Updated across: `gate-workflow.md` (DEV section), `custom/rules/project-conventions.md` (mandatory override table), skills (`read-study-requirement`, `generate-spec`, `review-plan`, `gate-review`), all 5 tool templates (`claude.md`, `cursor.md`, `copilot.md`, `gemini.md`, `generic.md`), and docs (`AIFLOW.md`, `ai-integration.md`, `workflows/bug-fix.md`, `workflows/feature.md`). ML workflows (`ml-gate-workflow.md`, `ml-conventions.md`) are intentionally NOT migrated yet.
|
|
33
|
+
- **SessionStart hook no longer injects legacy `plan/` paths** — `scripts/hooks/session-start.js` used to inject `Output plan/TASK-xxx/requirement.md` into every auto-start / resume message, overriding whatever the instruction file said (the root cause of outputs still landing in `plan/` even after template updates). The injected Gate 1 instructions (fast + full mode) now include the functionId Pre-flight step and point to `04.Coding/01.Requirements/[functionId]/<taskId>.md`; Gate 2/3 resume messages reference the new paths via the `04.Coding/00.Overview/_Index.md` tracker lookup.
|
|
34
|
+
- **CLI task commands follow the new doc layout** — `scripts/task.js`: new `findTaskDocs()` helper scans `04.Coding/*/*/<taskId>.md` (plus the legacy `plan/<taskId>/` folder) so `ak task reset` / `ak task remove` list and delete gate docs correctly; `detectCurrentGate()` now detects gate progress from the `04.Coding/` sections (with legacy fallback); `ak task next`'s cumulative `task-summary.md` moved from `plan/<taskId>/` to `.aiflow/tasks/<taskId>/` (it is internal task state, not a gate artifact).
|
|
35
|
+
|
|
20
36
|
- **Testing Skills Consolidation** — Consolidated all 11 testing/QA skills (previously at the root of `custom/skills/`) into the dedicated subfolder `custom/skills/test-skills/`. The skills moved are: `automation-testing`, `coverage-check`, `evidence-aggregation`, `execute-flow`, `generate-test-report`, `generate-testcase`, `log-bug`, `retest-orchestration`, `script-sync`, `test-analysis`, and `pr-impact-analysis`.
|
|
21
37
|
- **English Kebab-Case Naming Standard** — Standardized all skill filenames in `custom/skills/ba-skills/` and `custom/skills/test-skills/` to use English kebab-case naming conventions.
|
|
22
38
|
- **Output Directory Structure Migration** — Standardized output file templates, specs, and generated artifacts to use the new numbered directory architecture: `02.BA-Specs/`, `03.Testing/`, and `04.Coding/`.
|
|
@@ -1,53 +1,53 @@
|
|
|
1
|
-
# Multi-AI Environment Integration
|
|
2
|
-
|
|
3
|
-
`ai-flow-kit` is designed to be tool-agnostic. While it works best with Claude Code CLI due to deep MCP integration, you can use it with any AI tool.
|
|
4
|
-
|
|
5
|
-
## Supported Environments
|
|
6
|
-
|
|
7
|
-
| Tool | Instruction File | Support Level | Key Features |
|
|
8
|
-
|------|------------------|---------------|--------------|
|
|
9
|
-
| **Claude Code** | `CLAUDE.md` | Native (Best) | Auto-triggers, full MCP access, session hooks. |
|
|
10
|
-
| **Cursor** | `.cursorrules` | High | Project-wide rules, `@Codebase` context. |
|
|
11
|
-
| **Gemini CLI** | `GEMINI.md` | Medium | System instructions support. |
|
|
12
|
-
| **GitHub Copilot** | `.github/copilot-instructions.md` | Medium | Inline suggestions, custom instructions. |
|
|
13
|
-
| **OpenCode / Generic** | `AI_INSTRUCTIONS.md` | General | Manual context loading. |
|
|
14
|
-
|
|
15
|
-
---
|
|
16
|
-
|
|
17
|
-
## Tool-Specific Setup
|
|
18
|
-
|
|
19
|
-
### 1. Cursor AI
|
|
20
|
-
When you run `aiflow init`, it generates a `.cursorrules` file.
|
|
21
|
-
- Cursor will automatically read this file to understand the **Gate Workflow**.
|
|
22
|
-
- Use `@Codebase` when you need the AI to search across your whole project.
|
|
23
|
-
- **Resumption**: If you start a task in Claude Code and switch to Cursor, Cursor will see the generated `
|
|
24
|
-
|
|
25
|
-
### 2. Gemini CLI
|
|
26
|
-
Pass `GEMINI.md` as system instructions to your Gemini session.
|
|
27
|
-
- **Tip**: Always ensure the AI reads `.aiflow/context/current.json` first to load the ticket context.
|
|
28
|
-
- Gemini is excellent for large context analysis during Gate 1.
|
|
29
|
-
|
|
30
|
-
### 3. GitHub Copilot / Codex
|
|
31
|
-
Copilot uses `.github/copilot-instructions.md` to guide its suggestions.
|
|
32
|
-
- This ensures that Copilot's inline completions follow your project's architecture and team rules.
|
|
33
|
-
|
|
34
|
-
---
|
|
35
|
-
|
|
36
|
-
## Cross-Tool State Resumption
|
|
37
|
-
The "Secret Sauce" of `ai-flow-kit` is its file-based state management:
|
|
38
|
-
|
|
39
|
-
1. **Context**: Saved in `.aiflow/context/current.json`.
|
|
40
|
-
2. **Progress**: Saved as Markdown docs in `
|
|
41
|
-
3. **Rules**: Saved in `.rules/`.
|
|
42
|
-
|
|
43
|
-
Because these are standard files, any AI tool can read them. You can:
|
|
44
|
-
1. Start **Gate 1** (Analysis) in Claude Code.
|
|
45
|
-
2. Review and **Approve** the requirement doc.
|
|
46
|
-
3. Switch to **Cursor** for **Gate 3** (Coding) because you prefer the IDE integrations.
|
|
47
|
-
4. Switch back to **Claude Code** for **Gate 4** (Self-Review) to use its automated testing power.
|
|
48
|
-
|
|
49
|
-
---
|
|
50
|
-
|
|
51
|
-
## Best Practices
|
|
52
|
-
- **Always Approve Docs**: Ensure `requirement.md` and `plan.md` are approved (you can just type "APPROVED" in the chat or edit the file to say so).
|
|
53
|
-
- **Update Status**: If you make progress in a tool that doesn't have hooks, manually update the `summary.md` or the ticket status.
|
|
1
|
+
# Multi-AI Environment Integration
|
|
2
|
+
|
|
3
|
+
`ai-flow-kit` is designed to be tool-agnostic. While it works best with Claude Code CLI due to deep MCP integration, you can use it with any AI tool.
|
|
4
|
+
|
|
5
|
+
## Supported Environments
|
|
6
|
+
|
|
7
|
+
| Tool | Instruction File | Support Level | Key Features |
|
|
8
|
+
|------|------------------|---------------|--------------|
|
|
9
|
+
| **Claude Code** | `CLAUDE.md` | Native (Best) | Auto-triggers, full MCP access, session hooks. |
|
|
10
|
+
| **Cursor** | `.cursorrules` | High | Project-wide rules, `@Codebase` context. |
|
|
11
|
+
| **Gemini CLI** | `GEMINI.md` | Medium | System instructions support. |
|
|
12
|
+
| **GitHub Copilot** | `.github/copilot-instructions.md` | Medium | Inline suggestions, custom instructions. |
|
|
13
|
+
| **OpenCode / Generic** | `AI_INSTRUCTIONS.md` | General | Manual context loading. |
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Tool-Specific Setup
|
|
18
|
+
|
|
19
|
+
### 1. Cursor AI
|
|
20
|
+
When you run `aiflow init`, it generates a `.cursorrules` file.
|
|
21
|
+
- Cursor will automatically read this file to understand the **Gate Workflow**.
|
|
22
|
+
- Use `@Codebase` when you need the AI to search across your whole project.
|
|
23
|
+
- **Resumption**: If you start a task in Claude Code and switch to Cursor, Cursor will see the generated `AK-Docs/04.Coding/` docs and resume from where you left off.
|
|
24
|
+
|
|
25
|
+
### 2. Gemini CLI
|
|
26
|
+
Pass `GEMINI.md` as system instructions to your Gemini session.
|
|
27
|
+
- **Tip**: Always ensure the AI reads `.aiflow/context/current.json` first to load the ticket context.
|
|
28
|
+
- Gemini is excellent for large context analysis during Gate 1.
|
|
29
|
+
|
|
30
|
+
### 3. GitHub Copilot / Codex
|
|
31
|
+
Copilot uses `.github/copilot-instructions.md` to guide its suggestions.
|
|
32
|
+
- This ensures that Copilot's inline completions follow your project's architecture and team rules.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## Cross-Tool State Resumption
|
|
37
|
+
The "Secret Sauce" of `ai-flow-kit` is its file-based state management:
|
|
38
|
+
|
|
39
|
+
1. **Context**: Saved in `.aiflow/context/current.json`.
|
|
40
|
+
2. **Progress**: Saved as Markdown docs in `AK-Docs/04.Coding/<section>/[functionId]/[ticketId].md`.
|
|
41
|
+
3. **Rules**: Saved in `.rules/`.
|
|
42
|
+
|
|
43
|
+
Because these are standard files, any AI tool can read them. You can:
|
|
44
|
+
1. Start **Gate 1** (Analysis) in Claude Code.
|
|
45
|
+
2. Review and **Approve** the requirement doc.
|
|
46
|
+
3. Switch to **Cursor** for **Gate 3** (Coding) because you prefer the IDE integrations.
|
|
47
|
+
4. Switch back to **Claude Code** for **Gate 4** (Self-Review) to use its automated testing power.
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
## Best Practices
|
|
52
|
+
- **Always Approve Docs**: Ensure `requirement.md` and `plan.md` are approved (you can just type "APPROVED" in the chat or edit the file to say so).
|
|
53
|
+
- **Update Status**: If you make progress in a tool that doesn't have hooks, manually update the `summary.md` or the ticket status.
|
|
@@ -1,126 +1,126 @@
|
|
|
1
|
-
# Bug Fix Workflow
|
|
2
|
-
|
|
3
|
-
> See the full workflow at [AIFLOW.md](../../AIFLOW.md)
|
|
4
|
-
> **Gates must pass in order: 1 → 2 → 3 → 4 → 5**
|
|
5
|
-
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## Step 1: Load ticket & AI analyzes (Gate 1)
|
|
9
|
-
|
|
10
|
-
```bash
|
|
11
|
-
aiflow use PROJ-33 --with-comments # get both comments — important for bugs
|
|
12
|
-
claude # AI auto-starts Gate 1
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
AI will **automatically**:
|
|
16
|
-
1. Load ticket info + comments from Backlog/Jira
|
|
17
|
-
2. Read source code — trace data flow related to the bug
|
|
18
|
-
3. Use `superpowers:systematic-debugging` to form root cause hypothesis
|
|
19
|
-
4. Ask clarifying questions if reproduction steps are unclear
|
|
20
|
-
5. Output `
|
|
21
|
-
- Bug analysis (current vs expected behavior)
|
|
22
|
-
- **Root cause hypothesis** with evidence from source code
|
|
23
|
-
- **Proposed fix approach** (with alternatives if applicable)
|
|
24
|
-
- **Impact analysis** — will the fix break anything else?
|
|
25
|
-
- **Effort estimate** (S/M/L/XL)
|
|
26
|
-
- Testing plan (reproduce bug + verify fix)
|
|
27
|
-
|
|
28
|
-
**PM needs to prepare on the ticket:**
|
|
29
|
-
```markdown
|
|
30
|
-
## Description
|
|
31
|
-
Bug description: current behavior vs expected.
|
|
32
|
-
|
|
33
|
-
## Acceptance Criteria
|
|
34
|
-
- [ ] Bug no longer occurs
|
|
35
|
-
- [ ] [Other specific conditions]
|
|
36
|
-
|
|
37
|
-
## Reproduction Steps
|
|
38
|
-
1. [Step 1]
|
|
39
|
-
2. [Step 2]
|
|
40
|
-
3. Actual result: [what error, what screen]
|
|
41
|
-
4. Expected result: [...]
|
|
42
|
-
|
|
43
|
-
## Context
|
|
44
|
-
Error log (if any), environment (browser, OS, app version).
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
**If reproduction steps are unclear:** AI will ask based on what it found in the code.
|
|
48
|
-
|
|
49
|
-
**When satisfied with the requirement document, type:**
|
|
50
|
-
```
|
|
51
|
-
APPROVED
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
---
|
|
55
|
-
|
|
56
|
-
## Step 2: Review Implementation Plan (Gate 2)
|
|
57
|
-
|
|
58
|
-
AI generates:
|
|
59
|
-
- TDD plan: write test to reproduce bug → implement fix → verify
|
|
60
|
-
- Minimal fix approach (only edit the bug location)
|
|
61
|
-
|
|
62
|
-
**When agreed, type:**
|
|
63
|
-
```
|
|
64
|
-
APPROVED
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
---
|
|
68
|
-
|
|
69
|
-
## Step 3: AI Fix Code (Gate 3)
|
|
70
|
-
|
|
71
|
-
AI performs in the following order:
|
|
72
|
-
1. `superpowers:systematic-debugging` — confirm root cause
|
|
73
|
-
2. `investigate-bug` skill — trace Controller→Service→Repository to identify the bug layer
|
|
74
|
-
3. Write test to reproduce bug → run → confirm FAIL
|
|
75
|
-
4. Implement fix → tests PASS
|
|
76
|
-
5. Commit
|
|
77
|
-
|
|
78
|
-
**Principle:** Minimal fix — only edit the bug location, no extra changes.
|
|
79
|
-
|
|
80
|
-
---
|
|
81
|
-
|
|
82
|
-
## Step 4: Review Summary (Gate 4)
|
|
83
|
-
|
|
84
|
-
AI runs:
|
|
85
|
-
1. `superpowers:verification-before-completion` — all tests PASS (including old tests)
|
|
86
|
-
2. `impact-analysis` — fix doesn't cause new bugs elsewhere
|
|
87
|
-
3. Create `
|
|
88
|
-
|
|
89
|
-
**If OK, type:**
|
|
90
|
-
```
|
|
91
|
-
APPROVED
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
**If the fix is incorrect:**
|
|
95
|
-
```
|
|
96
|
-
BUG: [describe specifically what is wrong]
|
|
97
|
-
```
|
|
98
|
-
|
|
99
|
-
---
|
|
100
|
-
|
|
101
|
-
## Step 5: Peer Review & PR (Gate 5)
|
|
102
|
-
|
|
103
|
-
```bash
|
|
104
|
-
git push origin fix/PROJ-33-description
|
|
105
|
-
# PR title: fix: [PROJ-33] Short description
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
Commit message format:
|
|
109
|
-
```
|
|
110
|
-
fix: [PROJ-33] Payment processing timeout
|
|
111
|
-
|
|
112
|
-
Root cause: API timeout too short (5s), needs at least 10s
|
|
113
|
-
Fix: Increase timeout + add retry logic
|
|
114
|
-
|
|
115
|
-
Closes PROJ-33
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
---
|
|
119
|
-
|
|
120
|
-
## Completion Checklist
|
|
121
|
-
|
|
122
|
-
- [ ] Gate 1 APPROVED — requirement doc with root cause, fix approach, impact, estimate
|
|
123
|
-
- [ ] Gate 2 APPROVED — implementation plan confirmed
|
|
124
|
-
- [ ] Gate 3 done — test reproduce bug + fix → green
|
|
125
|
-
- [ ] Gate 4 APPROVED — no regression
|
|
126
|
-
- [ ] Gate 5 done — PR merged
|
|
1
|
+
# Bug Fix Workflow
|
|
2
|
+
|
|
3
|
+
> See the full workflow at [AIFLOW.md](../../AIFLOW.md)
|
|
4
|
+
> **Gates must pass in order: 1 → 2 → 3 → 4 → 5**
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Step 1: Load ticket & AI analyzes (Gate 1)
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
aiflow use PROJ-33 --with-comments # get both comments — important for bugs
|
|
12
|
+
claude # AI auto-starts Gate 1
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
AI will **automatically**:
|
|
16
|
+
1. Load ticket info + comments from Backlog/Jira
|
|
17
|
+
2. Read source code — trace data flow related to the bug
|
|
18
|
+
3. Use `superpowers:systematic-debugging` to form root cause hypothesis
|
|
19
|
+
4. Ask clarifying questions if reproduction steps are unclear
|
|
20
|
+
5. Output `AK-Docs/04.Coding/01.Requirements/[functionId]/[ticketId].md` containing:
|
|
21
|
+
- Bug analysis (current vs expected behavior)
|
|
22
|
+
- **Root cause hypothesis** with evidence from source code
|
|
23
|
+
- **Proposed fix approach** (with alternatives if applicable)
|
|
24
|
+
- **Impact analysis** — will the fix break anything else?
|
|
25
|
+
- **Effort estimate** (S/M/L/XL)
|
|
26
|
+
- Testing plan (reproduce bug + verify fix)
|
|
27
|
+
|
|
28
|
+
**PM needs to prepare on the ticket:**
|
|
29
|
+
```markdown
|
|
30
|
+
## Description
|
|
31
|
+
Bug description: current behavior vs expected.
|
|
32
|
+
|
|
33
|
+
## Acceptance Criteria
|
|
34
|
+
- [ ] Bug no longer occurs
|
|
35
|
+
- [ ] [Other specific conditions]
|
|
36
|
+
|
|
37
|
+
## Reproduction Steps
|
|
38
|
+
1. [Step 1]
|
|
39
|
+
2. [Step 2]
|
|
40
|
+
3. Actual result: [what error, what screen]
|
|
41
|
+
4. Expected result: [...]
|
|
42
|
+
|
|
43
|
+
## Context
|
|
44
|
+
Error log (if any), environment (browser, OS, app version).
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
**If reproduction steps are unclear:** AI will ask based on what it found in the code.
|
|
48
|
+
|
|
49
|
+
**When satisfied with the requirement document, type:**
|
|
50
|
+
```
|
|
51
|
+
APPROVED
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## Step 2: Review Implementation Plan (Gate 2)
|
|
57
|
+
|
|
58
|
+
AI generates:
|
|
59
|
+
- TDD plan: write test to reproduce bug → implement fix → verify
|
|
60
|
+
- Minimal fix approach (only edit the bug location)
|
|
61
|
+
|
|
62
|
+
**When agreed, type:**
|
|
63
|
+
```
|
|
64
|
+
APPROVED
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## Step 3: AI Fix Code (Gate 3)
|
|
70
|
+
|
|
71
|
+
AI performs in the following order:
|
|
72
|
+
1. `superpowers:systematic-debugging` — confirm root cause
|
|
73
|
+
2. `investigate-bug` skill — trace Controller→Service→Repository to identify the bug layer
|
|
74
|
+
3. Write test to reproduce bug → run → confirm FAIL
|
|
75
|
+
4. Implement fix → tests PASS
|
|
76
|
+
5. Commit
|
|
77
|
+
|
|
78
|
+
**Principle:** Minimal fix — only edit the bug location, no extra changes.
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## Step 4: Review Summary (Gate 4)
|
|
83
|
+
|
|
84
|
+
AI runs:
|
|
85
|
+
1. `superpowers:verification-before-completion` — all tests PASS (including old tests)
|
|
86
|
+
2. `impact-analysis` — fix doesn't cause new bugs elsewhere
|
|
87
|
+
3. Create `AK-Docs/04.Coding/04.Reviews/[functionId]/[ticketId].md`
|
|
88
|
+
|
|
89
|
+
**If OK, type:**
|
|
90
|
+
```
|
|
91
|
+
APPROVED
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
**If the fix is incorrect:**
|
|
95
|
+
```
|
|
96
|
+
BUG: [describe specifically what is wrong]
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## Step 5: Peer Review & PR (Gate 5)
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
git push origin fix/PROJ-33-description
|
|
105
|
+
# PR title: fix: [PROJ-33] Short description
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Commit message format:
|
|
109
|
+
```
|
|
110
|
+
fix: [PROJ-33] Payment processing timeout
|
|
111
|
+
|
|
112
|
+
Root cause: API timeout too short (5s), needs at least 10s
|
|
113
|
+
Fix: Increase timeout + add retry logic
|
|
114
|
+
|
|
115
|
+
Closes PROJ-33
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## Completion Checklist
|
|
121
|
+
|
|
122
|
+
- [ ] Gate 1 APPROVED — requirement doc with root cause, fix approach, impact, estimate
|
|
123
|
+
- [ ] Gate 2 APPROVED — implementation plan confirmed
|
|
124
|
+
- [ ] Gate 3 done — test reproduce bug + fix → green
|
|
125
|
+
- [ ] Gate 4 APPROVED — no regression
|
|
126
|
+
- [ ] Gate 5 done — PR merged
|