@mind-fold/open-flow 0.2.11 → 0.2.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/templates/commands/break-loop.txt +1 -1
- package/dist/templates/commands/check-cross-layer.txt +3 -3
- package/dist/templates/commands/create-command.txt +5 -5
- package/dist/templates/commands/extract-llm-docs.txt +18 -18
- package/dist/templates/commands/extract-to-rules.txt +38 -38
- package/dist/templates/commands/finish-work.txt +5 -5
- package/dist/templates/commands/generate-backend-structure.txt +27 -27
- package/dist/templates/commands/generate-frontend-structure.txt +15 -15
- package/dist/templates/commands/integrate-skill.txt +30 -30
- package/dist/templates/commands/onboard-developer.txt +24 -24
- package/dist/templates/commands/record-agent-flow.txt +4 -4
- package/dist/templates/commands/sync-from-runtime.txt +2 -2
- package/dist/templates/markdown/agent-progress-index.md.txt +9 -9
- package/dist/templates/markdown/backend-doc.md.txt +12 -12
- package/dist/templates/markdown/flow.md.txt +99 -99
- package/dist/templates/markdown/frontend-doc.md.txt +11 -11
- package/dist/templates/markdown/structure/backend/database-guidelines.md.txt +6 -6
- package/dist/templates/markdown/structure/backend/directory-structure.md.txt +28 -28
- package/dist/templates/markdown/structure/backend/index.md.txt +10 -10
- package/dist/templates/markdown/structure/backend/logging-guidelines.md.txt +4 -4
- package/dist/templates/markdown/structure/backend/quality-guidelines.md.txt +12 -12
- package/dist/templates/markdown/structure/backend/type-safety.md.txt +6 -6
- package/dist/templates/markdown/structure/flows/code-reuse-thinking-guide.md.txt +17 -17
- package/dist/templates/markdown/structure/flows/cross-layer-thinking-guide.md.txt +96 -96
- package/dist/templates/markdown/structure/flows/index.md.txt +31 -31
- package/dist/templates/markdown/structure/flows/pre-implementation-checklist.md.txt +19 -19
- package/dist/templates/markdown/structure/flows/spec-flow-template.md.txt +20 -20
- package/dist/templates/markdown/structure/frontend/component-guidelines.md.txt +12 -12
- package/dist/templates/markdown/structure/frontend/directory-structure.md.txt +61 -61
- package/dist/templates/markdown/structure/frontend/hook-guidelines.md.txt +5 -5
- package/dist/templates/markdown/structure/frontend/index.md.txt +13 -13
- package/dist/templates/markdown/structure/frontend/quality-guidelines.md.txt +21 -21
- package/dist/templates/markdown/structure/frontend/state-management.md.txt +12 -12
- package/dist/templates/markdown/structure/frontend/type-safety.md.txt +11 -11
- package/dist/templates/scripts/add-session.sh.txt +5 -5
- package/dist/templates/scripts/extract-md-headings.sh.txt +3 -3
- package/dist/templates/scripts/get-context.sh.txt +1 -1
- package/dist/templates/scripts/init-developer.sh.txt +1 -1
- package/dist/templates/scripts/update-index.sh.txt +2 -2
- package/package.json +1 -1
|
@@ -16,11 +16,11 @@ Adapt and integrate a Claude global skill into your project's development guidel
|
|
|
16
16
|
|
|
17
17
|
## Core Principle
|
|
18
18
|
|
|
19
|
-
>
|
|
19
|
+
> [!] **Important**: The goal of skill integration is to update **development guidelines**, not to generate project code directly.
|
|
20
20
|
>
|
|
21
|
-
> - Guidelines content
|
|
22
|
-
> - Code examples
|
|
23
|
-
> - Example files
|
|
21
|
+
> - Guidelines content -> Write to `workflow/structure/{target}/doc.md`
|
|
22
|
+
> - Code examples -> Place in `workflow/structure/{target}/examples/skills/<skill-name>/`
|
|
23
|
+
> - Example files -> Use `.template` suffix (e.g., `component.tsx.template`) to avoid IDE errors
|
|
24
24
|
>
|
|
25
25
|
> Where `{target}` is `frontend` or `backend`, determined by skill type.
|
|
26
26
|
|
|
@@ -64,7 +64,7 @@ Add a new section to the corresponding `doc.md`:
|
|
|
64
64
|
|
|
65
65
|
```markdown
|
|
66
66
|
@@@section:skill-<skill-name>
|
|
67
|
-
##
|
|
67
|
+
## # <Skill Name> Integration Guide
|
|
68
68
|
|
|
69
69
|
### Overview
|
|
70
70
|
[Core functionality and use cases of the skill]
|
|
@@ -91,14 +91,14 @@ See `examples/skills/<skill-name>/`
|
|
|
91
91
|
```bash
|
|
92
92
|
# Directory structure ({target} = frontend or backend)
|
|
93
93
|
workflow/structure/{target}/
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
94
|
+
|-- doc.md # Add skill-related section
|
|
95
|
+
|-- index.md # Update index
|
|
96
|
+
\-- examples/
|
|
97
|
+
\-- skills/
|
|
98
|
+
\-- <skill-name>/
|
|
99
|
+
|-- README.md # Example documentation
|
|
100
|
+
|-- example-1.ts.template # Code example (use .template suffix)
|
|
101
|
+
\-- example-2.tsx.template
|
|
102
102
|
```
|
|
103
103
|
|
|
104
104
|
**File naming conventions**:
|
|
@@ -120,17 +120,17 @@ Add to the Quick Navigation table in `index.md`:
|
|
|
120
120
|
|
|
121
121
|
## Skill Integration Report: `<skill-name>`
|
|
122
122
|
|
|
123
|
-
###
|
|
123
|
+
### # Overview
|
|
124
124
|
- **Skill description**: [Functionality description]
|
|
125
125
|
- **Integration target**: `workflow/structure/{target}/`
|
|
126
126
|
|
|
127
|
-
###
|
|
127
|
+
### # Tech Stack Compatibility
|
|
128
128
|
|
|
129
129
|
| Skill Requirement | Project Status | Compatibility |
|
|
130
130
|
|-------------------|----------------|---------------|
|
|
131
|
-
| [Tech 1] | [Project tech] |
|
|
131
|
+
| [Tech 1] | [Project tech] | [OK]/[!]/[X] |
|
|
132
132
|
|
|
133
|
-
###
|
|
133
|
+
### # Integration Locations
|
|
134
134
|
|
|
135
135
|
| Type | Path |
|
|
136
136
|
|------|------|
|
|
@@ -140,7 +140,7 @@ Add to the Quick Navigation table in `index.md`:
|
|
|
140
140
|
|
|
141
141
|
> `{target}` = `frontend` or `backend`
|
|
142
142
|
|
|
143
|
-
###
|
|
143
|
+
### # Dependencies (if needed)
|
|
144
144
|
|
|
145
145
|
```bash
|
|
146
146
|
# Install required dependencies (adjust for your package manager)
|
|
@@ -151,14 +151,14 @@ pnpm add <package>
|
|
|
151
151
|
yarn add <package>
|
|
152
152
|
```
|
|
153
153
|
|
|
154
|
-
###
|
|
154
|
+
### [OK] Completed Changes
|
|
155
155
|
|
|
156
156
|
- [ ] Added `@@@section:skill-<name>` section to `doc.md`
|
|
157
157
|
- [ ] Added index entry to `index.md`
|
|
158
158
|
- [ ] Created example files in `examples/skills/<name>/`
|
|
159
159
|
- [ ] Example files use `.template` suffix
|
|
160
160
|
|
|
161
|
-
###
|
|
161
|
+
### # Related Guidelines
|
|
162
162
|
|
|
163
163
|
- [Existing related section IDs]
|
|
164
164
|
|
|
@@ -187,22 +187,22 @@ If this skill is frequently used, create a shortcut command:
|
|
|
187
187
|
|
|
188
188
|
```
|
|
189
189
|
workflow/structure/backend/
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
190
|
+
|-- doc.md # Add MCP section
|
|
191
|
+
|-- index.md # Add index entry
|
|
192
|
+
\-- examples/
|
|
193
|
+
\-- skills/
|
|
194
|
+
\-- mcp-builder/
|
|
195
|
+
|-- README.md
|
|
196
|
+
|-- server.ts.template
|
|
197
|
+
|-- tools.ts.template
|
|
198
|
+
\-- types.ts.template
|
|
199
199
|
```
|
|
200
200
|
|
|
201
201
|
### New Section in doc.md
|
|
202
202
|
|
|
203
203
|
```markdown
|
|
204
204
|
@@@section:skill-mcp-builder
|
|
205
|
-
##
|
|
205
|
+
## # MCP Server Development Guide
|
|
206
206
|
|
|
207
207
|
### Overview
|
|
208
208
|
Create LLM-callable tool services using MCP (Model Context Protocol).
|
|
@@ -365,14 +365,14 @@ Syncs knowledge and patterns from runtime documentation.
|
|
|
365
365
|
|
|
366
366
|
```
|
|
367
367
|
1. /init-agent
|
|
368
|
-
|
|
369
|
-
|
|
368
|
+
-> See context: Branch "main", 2 uncommitted files
|
|
369
|
+
-> Active feature: none
|
|
370
370
|
|
|
371
371
|
2. Create feature:
|
|
372
372
|
./workflow/scripts/feature.sh create fix-sync-indicator
|
|
373
373
|
|
|
374
374
|
3. /before-frontend-dev
|
|
375
|
-
|
|
375
|
+
-> Read component guidelines
|
|
376
376
|
|
|
377
377
|
4. Investigate and fix:
|
|
378
378
|
- Analyze old vs new architecture
|
|
@@ -380,18 +380,18 @@ Syncs knowledge and patterns from runtime documentation.
|
|
|
380
380
|
- Add CSS styles
|
|
381
381
|
|
|
382
382
|
5. /check-frontend
|
|
383
|
-
|
|
384
|
-
|
|
383
|
+
-> Type check: [OK] passed
|
|
384
|
+
-> Lint: [OK] 0 errors
|
|
385
385
|
|
|
386
386
|
6. /finish-work
|
|
387
|
-
|
|
388
|
-
|
|
387
|
+
-> Pre-commit checklist
|
|
388
|
+
-> Confirm all changes are ready
|
|
389
389
|
|
|
390
390
|
7. Human tests and commits:
|
|
391
391
|
git commit -m "fix(ui): restore SyncIndicator to TabBar"
|
|
392
392
|
|
|
393
393
|
8. /record-agent-flow
|
|
394
|
-
|
|
394
|
+
-> ./workflow/scripts/add-session.sh --title "Fix SyncIndicator" --commit "abc123"
|
|
395
395
|
|
|
396
396
|
9. Archive feature:
|
|
397
397
|
./workflow/scripts/feature.sh archive fix-sync-indicator
|
|
@@ -403,7 +403,7 @@ Syncs knowledge and patterns from runtime documentation.
|
|
|
403
403
|
|
|
404
404
|
```
|
|
405
405
|
1. /init-agent
|
|
406
|
-
|
|
406
|
+
-> Understand current state
|
|
407
407
|
|
|
408
408
|
2. Create feature:
|
|
409
409
|
./workflow/scripts/feature.sh create migration-docs-consolidation
|
|
@@ -416,7 +416,7 @@ Syncs knowledge and patterns from runtime documentation.
|
|
|
416
416
|
- Medium: Consolidate scattered docs
|
|
417
417
|
|
|
418
418
|
5. /record-agent-flow (no commit)
|
|
419
|
-
|
|
419
|
+
-> ./workflow/scripts/add-session.sh --title "Migration Docs Planning" --summary "Created 14 subtasks"
|
|
420
420
|
```
|
|
421
421
|
|
|
422
422
|
### Example 3: Code Review Fixes
|
|
@@ -425,10 +425,10 @@ Syncs knowledge and patterns from runtime documentation.
|
|
|
425
425
|
|
|
426
426
|
```
|
|
427
427
|
1. /init-agent
|
|
428
|
-
|
|
428
|
+
-> Continue feature: entity-filesystem-refactor
|
|
429
429
|
|
|
430
430
|
2. /before-backend-dev
|
|
431
|
-
|
|
431
|
+
-> Read database and error handling guidelines
|
|
432
432
|
|
|
433
433
|
3. Fix each CR issue:
|
|
434
434
|
- Add missing workspaceId filter (data isolation)
|
|
@@ -436,11 +436,11 @@ Syncs knowledge and patterns from runtime documentation.
|
|
|
436
436
|
- Add LWW conflict resolution
|
|
437
437
|
|
|
438
438
|
4. /check-backend
|
|
439
|
-
|
|
439
|
+
-> All checks passed
|
|
440
440
|
|
|
441
441
|
5. /finish-work
|
|
442
|
-
|
|
443
|
-
|
|
442
|
+
-> Pre-commit checklist
|
|
443
|
+
-> Document lessons learned:
|
|
444
444
|
- "All queries with workspaceId column must include WHERE clause"
|
|
445
445
|
- "buildXxxValues must match *DataSchema types"
|
|
446
446
|
|
|
@@ -453,7 +453,7 @@ Syncs knowledge and patterns from runtime documentation.
|
|
|
453
453
|
|
|
454
454
|
```
|
|
455
455
|
1. /init-agent
|
|
456
|
-
|
|
456
|
+
-> Create feature: workflow-monorepo-adaptation
|
|
457
457
|
|
|
458
458
|
2. Plan phases:
|
|
459
459
|
- Phase 1: Root directory restructure
|
|
@@ -464,7 +464,7 @@ Syncs knowledge and patterns from runtime documentation.
|
|
|
464
464
|
3. Execute phase by phase, running /check-* after each
|
|
465
465
|
|
|
466
466
|
4. /finish-work
|
|
467
|
-
|
|
467
|
+
-> Final verification checklist
|
|
468
468
|
|
|
469
469
|
5. Human commits multiple times, record with multiple commit hashes:
|
|
470
470
|
./workflow/scripts/add-session.sh --title "Monorepo Adaptation" --commit "hash1,hash2,hash3"
|
|
@@ -476,10 +476,10 @@ Syncs knowledge and patterns from runtime documentation.
|
|
|
476
476
|
|
|
477
477
|
```
|
|
478
478
|
1. /init-agent
|
|
479
|
-
|
|
479
|
+
-> Continue feature: fix-sync-data-inconsistency
|
|
480
480
|
|
|
481
481
|
2. /before-backend-dev
|
|
482
|
-
|
|
482
|
+
-> Read sync and database guidelines
|
|
483
483
|
|
|
484
484
|
3. Investigation loop:
|
|
485
485
|
- Analyze cloud vs local data
|
|
@@ -488,22 +488,22 @@ Syncs knowledge and patterns from runtime documentation.
|
|
|
488
488
|
- Add debug logging
|
|
489
489
|
|
|
490
490
|
4. /check-backend
|
|
491
|
-
|
|
491
|
+
-> All checks passed
|
|
492
492
|
|
|
493
493
|
5. /break-loop (when investigation is complete)
|
|
494
|
-
|
|
494
|
+
-> Summarize findings:
|
|
495
495
|
- Root cause: Transaction failure without error logging
|
|
496
496
|
- Temporary fix: Manual SQL update
|
|
497
497
|
- Permanent fix: Add detailed logging in applyEvent
|
|
498
|
-
|
|
498
|
+
-> Document for future reference
|
|
499
499
|
|
|
500
500
|
6. /finish-work
|
|
501
|
-
|
|
501
|
+
-> Pre-commit checklist
|
|
502
502
|
|
|
503
503
|
7. Human tests and commits
|
|
504
504
|
|
|
505
505
|
8. /record-agent-flow
|
|
506
|
-
|
|
506
|
+
-> Include lessons learned in session record
|
|
507
507
|
```
|
|
508
508
|
|
|
509
509
|
---
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
[!] **Prerequisite**: This command should only be used AFTER the human has tested and committed the code.
|
|
2
2
|
|
|
3
3
|
**AI must NOT execute git commit** - only read history (`git log`, `git status`, `git diff`).
|
|
4
4
|
|
|
@@ -35,9 +35,9 @@ EOF
|
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
**Auto-completes**:
|
|
38
|
-
-
|
|
39
|
-
-
|
|
40
|
-
-
|
|
38
|
+
- [OK] Appends session to progress-N.md
|
|
39
|
+
- [OK] Auto-detects line count, creates new file if >2000 lines
|
|
40
|
+
- [OK] Updates index.md (Total Sessions +1, Last Active, line stats, history)
|
|
41
41
|
|
|
42
42
|
---
|
|
43
43
|
|
|
@@ -120,8 +120,8 @@ After sync, report:
|
|
|
120
120
|
### Synced Docs
|
|
121
121
|
| Doc | Status | Notes |
|
|
122
122
|
|-----|--------|-------|
|
|
123
|
-
| database-guidelines.md |
|
|
124
|
-
| logging-guidelines.md |
|
|
123
|
+
| database-guidelines.md | [OK] Added | Adapted from Turso to generic ORM |
|
|
124
|
+
| logging-guidelines.md | [OK] Added | No changes needed |
|
|
125
125
|
|
|
126
126
|
### Updated Files
|
|
127
127
|
- workflow/structure/backend/index.md (added links)
|
|
@@ -12,13 +12,13 @@ This directory tracks progress for all developers working with AI Agents on this
|
|
|
12
12
|
|
|
13
13
|
```
|
|
14
14
|
agent-progress/
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
15
|
+
|-- index.md # This file - main index
|
|
16
|
+
\-- {developer}/ # Per-developer directory
|
|
17
|
+
|-- index.md # Personal index with session history
|
|
18
|
+
|-- features/ # Feature files
|
|
19
|
+
| |-- *.json # Active features
|
|
20
|
+
| \-- archive/ # Archived features by month
|
|
21
|
+
\-- progress-N.md # Progress files (sequential: 1, 2, 3...)
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
---
|
|
@@ -106,11 +106,11 @@ Use this template when recording sessions:
|
|
|
106
106
|
|
|
107
107
|
### Testing
|
|
108
108
|
|
|
109
|
-
-
|
|
109
|
+
- [OK] {Test result}
|
|
110
110
|
|
|
111
111
|
### Status
|
|
112
112
|
|
|
113
|
-
|
|
113
|
+
[OK] **Completed** / # **In Progress** / [P] **Blocked**
|
|
114
114
|
|
|
115
115
|
### Next Steps
|
|
116
116
|
|
|
@@ -9,12 +9,12 @@
|
|
|
9
9
|
|
|
10
10
|
```
|
|
11
11
|
packages/api/modules/
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
12
|
+
|-- {module}/
|
|
13
|
+
| |-- router.ts # Route definitions
|
|
14
|
+
| |-- procedures/ # Business logic
|
|
15
|
+
| |-- types.ts # Type definitions
|
|
16
|
+
| \-- api/ # API documentation
|
|
17
|
+
| \-- *.md
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
@@@/section:directory-structure
|
|
@@ -28,14 +28,14 @@ packages/api/modules/
|
|
|
28
28
|
### No Non-Null Assertions
|
|
29
29
|
|
|
30
30
|
```typescript
|
|
31
|
-
//
|
|
31
|
+
// [OK] Good - use local variable
|
|
32
32
|
const user = await getUser(id);
|
|
33
33
|
if (!user) {
|
|
34
34
|
throw new Error('User not found');
|
|
35
35
|
}
|
|
36
36
|
const userName = user.name; // Safe access
|
|
37
37
|
|
|
38
|
-
//
|
|
38
|
+
// [X] Bad - non-null assertion
|
|
39
39
|
const userName = user!.name;
|
|
40
40
|
```
|
|
41
41
|
|
|
@@ -69,12 +69,12 @@ const outputSchema = z.object({
|
|
|
69
69
|
### No Await in Loops
|
|
70
70
|
|
|
71
71
|
```typescript
|
|
72
|
-
//
|
|
72
|
+
// [OK] Good - parallel execution
|
|
73
73
|
const results = await Promise.all(
|
|
74
74
|
ids.map(id => db.query.users.findFirst({ where: eq(users.id, id) }))
|
|
75
75
|
);
|
|
76
76
|
|
|
77
|
-
//
|
|
77
|
+
// [X] Bad - sequential execution
|
|
78
78
|
for (const id of ids) {
|
|
79
79
|
await db.query.users.findFirst({ where: eq(users.id, id) });
|
|
80
80
|
}
|
|
@@ -111,10 +111,10 @@ await db.insert(users).values(data).onConflictDoUpdate({
|
|
|
111
111
|
### Use Structured Logging
|
|
112
112
|
|
|
113
113
|
```typescript
|
|
114
|
-
//
|
|
114
|
+
// [OK] Good
|
|
115
115
|
logger.info('User created', { userId: user.id, email: user.email });
|
|
116
116
|
|
|
117
|
-
//
|
|
117
|
+
// [X] Bad
|
|
118
118
|
console.log('User created: ' + user.id);
|
|
119
119
|
```
|
|
120
120
|
|