superkit-mcp-server 1.2.1 → 1.2.3
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/ARCHITECTURE.md +102 -102
- package/README.md +71 -71
- package/SUPERKIT.md +168 -168
- package/agents/code-archaeologist.md +106 -106
- package/agents/coder.md +90 -90
- package/agents/data-engineer.md +28 -28
- package/agents/devops-engineer.md +242 -242
- package/agents/git-manager.md +203 -203
- package/agents/orchestrator.md +420 -420
- package/agents/penetration-tester.md +188 -188
- package/agents/performance-optimizer.md +187 -187
- package/agents/planner.md +270 -270
- package/agents/qa-automation-engineer.md +103 -103
- package/agents/quant-developer.md +32 -32
- package/agents/reviewer.md +100 -100
- package/agents/scout.md +222 -222
- package/agents/security-auditor.md +3 -2
- package/agents/tester.md +274 -274
- package/agents/ui-designer.md +208 -208
- package/build/index.js +21 -2
- package/build/tools/__tests__/loggerTools.test.js +5 -5
- package/build/tools/archTools.js +2 -19
- package/build/tools/autoPreview.js +2 -2
- package/build/tools/compoundTools.js +4 -4
- package/build/tools/docsTools.js +5 -10
- package/build/tools/loggerTools.js +1 -1
- package/build/tools/todoTools.js +39 -39
- package/build/tools/validators/__tests__/apiSchema.test.js +23 -23
- package/build/tools/validators/__tests__/convertRules.test.js +5 -5
- package/build/tools/validators/__tests__/frontendDesign.test.js +12 -12
- package/build/tools/validators/__tests__/geoChecker.test.js +19 -19
- package/build/tools/validators/__tests__/mobileAudit.test.js +12 -12
- package/build/tools/validators/__tests__/reactPerformanceChecker.test.js +17 -17
- package/build/tools/validators/__tests__/securityScan.test.js +6 -6
- package/build/tools/validators/__tests__/seoChecker.test.js +16 -16
- package/build/tools/validators/__tests__/typeCoverage.test.js +14 -14
- package/build/tools/validators/convertRules.js +2 -2
- package/commands/README.md +122 -122
- package/commands/ask.toml +72 -72
- package/commands/brainstorm.toml +119 -119
- package/commands/chat.toml +77 -77
- package/commands/code-preview.toml +37 -37
- package/commands/code.toml +28 -28
- package/commands/content.toml +200 -200
- package/commands/cook.toml +77 -77
- package/commands/copywrite.toml +131 -131
- package/commands/db.toml +192 -192
- package/commands/debug.toml +166 -166
- package/commands/design.toml +158 -158
- package/commands/dev-rules.toml +14 -14
- package/commands/do.toml +117 -117
- package/commands/doc-rules.toml +14 -14
- package/commands/docs.toml +148 -148
- package/commands/fix.toml +440 -440
- package/commands/fullstack.toml +175 -175
- package/commands/git.toml +235 -235
- package/commands/help.toml +84 -84
- package/commands/integrate.toml +127 -127
- package/commands/journal.toml +136 -136
- package/commands/kit-setup.toml +40 -40
- package/commands/mcp.toml +183 -183
- package/commands/orchestration.toml +15 -15
- package/commands/plan.toml +171 -171
- package/commands/pm.toml +148 -148
- package/commands/pr.toml +50 -50
- package/commands/project.toml +32 -32
- package/commands/research.toml +117 -117
- package/commands/review-pr.toml +63 -63
- package/commands/review.toml +190 -190
- package/commands/scout-ext.toml +97 -97
- package/commands/scout.toml +79 -79
- package/commands/screenshot.toml +65 -65
- package/commands/session.toml +102 -102
- package/commands/skill.toml +384 -384
- package/commands/status.toml +22 -22
- package/commands/team.toml +56 -56
- package/commands/test.toml +164 -164
- package/commands/ticket.toml +70 -70
- package/commands/use.toml +106 -106
- package/commands/video.toml +83 -83
- package/commands/watzup.toml +71 -71
- package/commands/workflow.toml +14 -14
- package/package.json +35 -35
- package/skills/meta/README.md +30 -30
- package/skills/meta/api-design/SKILL.md +134 -134
- package/skills/meta/code-review/SKILL.md +44 -44
- package/skills/meta/code-review/checklists/pre-merge.md +25 -25
- package/skills/meta/code-review/workflows/architecture-pass.md +26 -26
- package/skills/meta/code-review/workflows/performance-pass.md +27 -27
- package/skills/meta/code-review/workflows/security-pass.md +29 -29
- package/skills/meta/compound-docs/SKILL.md +133 -133
- package/skills/meta/debug/SKILL.md +40 -40
- package/skills/meta/debug/templates/bug-report.template.md +31 -31
- package/skills/meta/debug/workflows/reproduce-issue.md +20 -20
- package/skills/meta/docker/SKILL.md +126 -126
- package/skills/meta/examples/supabase/SKILL.md +46 -46
- package/skills/meta/examples/supabase/references/best-practices.md +319 -319
- package/skills/meta/examples/supabase/references/common-patterns.md +373 -373
- package/skills/meta/examples/supabase/templates/migration-template.sql +49 -49
- package/skills/meta/examples/supabase/templates/rls-policy-template.sql +77 -77
- package/skills/meta/examples/supabase/workflows/debugging.md +260 -260
- package/skills/meta/examples/supabase/workflows/migration-workflow.md +211 -211
- package/skills/meta/examples/supabase/workflows/rls-policies.md +244 -244
- package/skills/meta/examples/supabase/workflows/schema-design.md +321 -321
- package/skills/meta/file-todos/SKILL.md +88 -88
- package/skills/meta/mobile/SKILL.md +140 -140
- package/skills/meta/nextjs/SKILL.md +101 -101
- package/skills/meta/performance/SKILL.md +130 -130
- package/skills/meta/react-patterns/SKILL.md +83 -83
- package/skills/meta/security/SKILL.md +114 -114
- package/skills/meta/session-resume/SKILL.md +96 -96
- package/skills/meta/tailwind/SKILL.md +139 -139
- package/skills/meta/testing/SKILL.md +43 -43
- package/skills/meta/testing/references/vitest-patterns.md +45 -45
- package/skills/meta/testing/templates/component-test.template.tsx +37 -37
- package/skills/tech/alpha-vantage/SKILL.md +142 -142
- package/skills/tech/alpha-vantage/references/commodities.md +153 -153
- package/skills/tech/alpha-vantage/references/economic-indicators.md +158 -158
- package/skills/tech/alpha-vantage/references/forex-crypto.md +154 -154
- package/skills/tech/alpha-vantage/references/fundamentals.md +223 -223
- package/skills/tech/alpha-vantage/references/intelligence.md +138 -138
- package/skills/tech/alpha-vantage/references/options.md +93 -93
- package/skills/tech/alpha-vantage/references/technical-indicators.md +374 -374
- package/skills/tech/alpha-vantage/references/time-series.md +157 -157
- package/skills/tech/doc.md +6 -6
- package/skills/tech/financial-modeling/SKILL.md +18 -18
- package/skills/tech/financial-modeling/skills/3-statements/SKILL.md +368 -368
- package/skills/tech/financial-modeling/skills/3-statements/references/formatting.md +118 -118
- package/skills/tech/financial-modeling/skills/3-statements/references/formulas.md +292 -292
- package/skills/tech/financial-modeling/skills/3-statements/references/sec-filings.md +125 -125
- package/skills/tech/financial-modeling/skills/dcf-model/SKILL.md +1210 -1210
- package/skills/tech/financial-modeling/skills/dcf-model/TROUBLESHOOTING.md +40 -40
- package/skills/tech/financial-modeling/skills/dcf-model/requirements.txt +8 -8
- package/skills/tech/financial-modeling/skills/dcf-model/scripts/validate_dcf.py +292 -292
- package/skills/tech/financial-modeling/skills/lbo-model/SKILL.md +236 -236
- package/skills/tech/financial-modeling/skills/merger-model/SKILL.md +108 -108
- package/skills/workflows/README.md +203 -203
- package/skills/workflows/adr.md +174 -174
- package/skills/workflows/changelog.md +74 -74
- package/skills/workflows/compound.md +323 -323
- package/skills/workflows/compound_health.md +74 -74
- package/skills/workflows/create-agent-skill.md +138 -139
- package/skills/workflows/cycle.md +144 -144
- package/skills/workflows/deploy-docs.md +84 -84
- package/skills/workflows/development-rules.md +42 -42
- package/skills/workflows/doc.md +95 -95
- package/skills/workflows/documentation-management.md +34 -34
- package/skills/workflows/explore.md +146 -146
- package/skills/workflows/generate_command.md +106 -106
- package/skills/workflows/heal-skill.md +97 -97
- package/skills/workflows/housekeeping.md +229 -229
- package/skills/workflows/kit-setup.md +102 -102
- package/skills/workflows/map-codebase.md +78 -78
- package/skills/workflows/orchestration-protocol.md +43 -43
- package/skills/workflows/plan-compound.md +439 -439
- package/skills/workflows/plan_review.md +269 -269
- package/skills/workflows/primary-workflow.md +37 -37
- package/skills/workflows/promote_pattern.md +86 -86
- package/skills/workflows/release-docs.md +82 -82
- package/skills/workflows/report-bug.md +135 -135
- package/skills/workflows/reproduce-bug.md +118 -118
- package/skills/workflows/resolve_pr.md +133 -133
- package/skills/workflows/resolve_todo.md +128 -128
- package/skills/workflows/review-compound.md +376 -376
- package/skills/workflows/skill-review.md +127 -127
- package/skills/workflows/specs.md +257 -257
- package/skills/workflows/triage-sprint.md +102 -102
- package/skills/workflows/triage.md +152 -152
- package/skills/workflows/work.md +399 -399
- package/skills/workflows/xcode-test.md +93 -93
package/skills/workflows/adr.md
CHANGED
|
@@ -1,174 +1,174 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: Create a new Architecture Decision Record. Use when making significant technical choices.
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
# /adr - Record Architectural Decision
|
|
6
|
-
|
|
7
|
-
Capture long-term architectural choices that should persist beyond individual plans or specs.
|
|
8
|
-
|
|
9
|
-
> **Why ADRs?** Implementation plans are transient. Decisions that shape the project should be permanent, searchable, and prevent re-litigation.
|
|
10
|
-
|
|
11
|
-
## When To Use
|
|
12
|
-
|
|
13
|
-
**Triggers:**
|
|
14
|
-
- Choosing between competing technologies/libraries
|
|
15
|
-
- Defining new patterns or conventions
|
|
16
|
-
- Making breaking changes with long-term impact
|
|
17
|
-
- Decisions that future developers need to understand "why"
|
|
18
|
-
|
|
19
|
-
**Examples:**
|
|
20
|
-
- "We will use GraphQL instead of REST for the External API"
|
|
21
|
-
- "We adopt the Tailwind framework as our single source of UI primitives"
|
|
22
|
-
- "All backend dates will be stored in UTC"
|
|
23
|
-
|
|
24
|
-
**Skip ADRs for:**
|
|
25
|
-
- Routine implementation choices
|
|
26
|
-
- Bug fixes
|
|
27
|
-
- Decisions scoped to a single spec (use `04-decisions.md` instead)
|
|
28
|
-
|
|
29
|
-
---
|
|
30
|
-
|
|
31
|
-
## Workflow
|
|
32
|
-
|
|
33
|
-
### Step 0: Search & Log
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
// turbo
|
|
37
|
-
Call MCP `call_tool_logger_manager` { action: "logWorkflow", name: "/adr", outcome: "success" }
|
|
38
|
-
Call MCP `call_tool_compound_manager` { action: "search", terms: [ "architectural decision"] }
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
### Step 1: Check Existing ADRs (MANDATORY)
|
|
42
|
-
|
|
43
|
-
> [!CAUTION]
|
|
44
|
-
> **BLOCKING STEP.** Check if this decision has already been made.
|
|
45
|
-
|
|
46
|
-
```bash
|
|
47
|
-
// turbo
|
|
48
|
-
Call MCP `call_tool_compound_manager` { action: "search", terms: [ "{decision keywords}"] }
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
If an existing ADR covers this decision → Reference it; don't create a duplicate.
|
|
52
|
-
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
### Step 1: Get Next ID
|
|
56
|
-
```bash
|
|
57
|
-
// turbo
|
|
58
|
-
next_id=$(printf "%03d" $(( $(ls -1 docs/decisions/*.md 2>/dev/null | xargs -n1 basename | grep -E '^[0-9]{3}-' | wc -l) + 1 )))
|
|
59
|
-
echo "Next ADR ID: $next_id"
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
### Step 2: Create From Template
|
|
63
|
-
```bash
|
|
64
|
-
cp docs/decisions/adr-template.md docs/decisions/${next_id}-{decision-slug}.md
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
Use a descriptive slug, e.g., `002-adopt-graphql-for-external-api.md`
|
|
68
|
-
|
|
69
|
-
### Step 3: Fill Core Sections
|
|
70
|
-
|
|
71
|
-
Open the new file and complete:
|
|
72
|
-
|
|
73
|
-
| Section | Content |
|
|
74
|
-
|---------|---------|
|
|
75
|
-
| **Context** | What problem or situation led to this decision? What constraints exist? |
|
|
76
|
-
| **Decision** | The specific choice made (be authoritative). |
|
|
77
|
-
| **Alternatives** | What else was considered? Why rejected? |
|
|
78
|
-
| **Consequences** | Trade-offs: positive AND negative. |
|
|
79
|
-
|
|
80
|
-
### Step 4: Link to Source
|
|
81
|
-
|
|
82
|
-
Update the `## Related` section:
|
|
83
|
-
- Link to originating `/plan` or `/spec` if applicable
|
|
84
|
-
- Note if this supersedes a previous ADR
|
|
85
|
-
|
|
86
|
-
### Step 5: Update Frontmatter
|
|
87
|
-
|
|
88
|
-
Ensure YAML is valid:
|
|
89
|
-
```yaml
|
|
90
|
-
---
|
|
91
|
-
id: "ADR-{NNN}"
|
|
92
|
-
title: "{Decision Title}"
|
|
93
|
-
date: "YYYY-MM-DD"
|
|
94
|
-
status: "accepted" # or proposed, deprecated, superseded
|
|
95
|
-
tags: [database, api, frontend, infrastructure, patterns, dependencies]
|
|
96
|
-
last_referenced: "YYYY-MM-DD"
|
|
97
|
-
---
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
### Step 6: Offer Next Steps
|
|
101
|
-
|
|
102
|
-
```
|
|
103
|
-
✓ ADR created: docs/decisions/{next_id}-{slug}.md
|
|
104
|
-
|
|
105
|
-
What's next?
|
|
106
|
-
1. Get review - Share with team for feedback
|
|
107
|
-
2. Link in plan - Reference ADR in your implementation plan
|
|
108
|
-
3. Continue working - Decision is now recorded
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
### Phase 5: Completion & Handoff
|
|
112
|
-
|
|
113
|
-
#### Step 1: Establish Terminal UI State
|
|
114
|
-
|
|
115
|
-
```javascript
|
|
116
|
-
await task_boundary({
|
|
117
|
-
TaskName: "[COMPLETED] Create ADR",
|
|
118
|
-
TaskStatus: "ADR created and filed. Offering next steps.",
|
|
119
|
-
Mode: "VERIFICATION",
|
|
120
|
-
TaskSummary: "Created ADR-{NNN}: {Title}. Documented decision context and consequences."
|
|
121
|
-
});
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
#### Step 2: Mandatory Handoff
|
|
125
|
-
|
|
126
|
-
```bash
|
|
127
|
-
✓ ADR created
|
|
128
|
-
|
|
129
|
-
Next steps:
|
|
130
|
-
1. /plan - Create implementation plan for this decision
|
|
131
|
-
2. /work - Start implementing
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
---
|
|
135
|
-
|
|
136
|
-
## Lifecycle Management
|
|
137
|
-
|
|
138
|
-
| Status | Meaning |
|
|
139
|
-
|--------|---------|
|
|
140
|
-
| `proposed` | Under discussion, not yet agreed |
|
|
141
|
-
| `accepted` | Agreed and currently in force |
|
|
142
|
-
| `deprecated` | Guidance to stop using; legacy may exist |
|
|
143
|
-
| `superseded` | Replaced by a newer ADR (link to it) |
|
|
144
|
-
|
|
145
|
-
**To supersede an ADR:**
|
|
146
|
-
1. Create new ADR with updated decision
|
|
147
|
-
2. Add `superseded_by: "ADR-{NNN}"` to old ADR's frontmatter
|
|
148
|
-
3. Change old ADR status to `superseded`
|
|
149
|
-
|
|
150
|
-
---
|
|
151
|
-
|
|
152
|
-
## Quality Guidelines
|
|
153
|
-
|
|
154
|
-
**Good ADRs have:**
|
|
155
|
-
- ✅ Clear context (the "why")
|
|
156
|
-
- ✅ Explicit decision statement
|
|
157
|
-
- ✅ Alternatives with rejection reasons
|
|
158
|
-
- ✅ Honest consequences (including negatives)
|
|
159
|
-
|
|
160
|
-
**Avoid:**
|
|
161
|
-
- ❌ Vague rationale ("seemed better")
|
|
162
|
-
- ❌ Missing alternatives
|
|
163
|
-
- ❌ Only positive consequences listed
|
|
164
|
-
- ❌ Implementation details (that's for plans)
|
|
165
|
-
|
|
166
|
-
---
|
|
167
|
-
|
|
168
|
-
## References
|
|
169
|
-
|
|
170
|
-
- Directory: `docs/decisions/`
|
|
171
|
-
- Template: `docs/decisions/adr-template.md`
|
|
172
|
-
- Search decisions: `Call MCP `call_tool_compound_manager` { action: "search", terms: [] }`
|
|
173
|
-
- Integration: `/plan` Step 5.5 and `/specs` Step 4
|
|
174
|
-
- Standard: [Michael Nygard's ADR format](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions)
|
|
1
|
+
---
|
|
2
|
+
description: Create a new Architecture Decision Record. Use when making significant technical choices.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# /adr - Record Architectural Decision
|
|
6
|
+
|
|
7
|
+
Capture long-term architectural choices that should persist beyond individual plans or specs.
|
|
8
|
+
|
|
9
|
+
> **Why ADRs?** Implementation plans are transient. Decisions that shape the project should be permanent, searchable, and prevent re-litigation.
|
|
10
|
+
|
|
11
|
+
## When To Use
|
|
12
|
+
|
|
13
|
+
**Triggers:**
|
|
14
|
+
- Choosing between competing technologies/libraries
|
|
15
|
+
- Defining new patterns or conventions
|
|
16
|
+
- Making breaking changes with long-term impact
|
|
17
|
+
- Decisions that future developers need to understand "why"
|
|
18
|
+
|
|
19
|
+
**Examples:**
|
|
20
|
+
- "We will use GraphQL instead of REST for the External API"
|
|
21
|
+
- "We adopt the Tailwind framework as our single source of UI primitives"
|
|
22
|
+
- "All backend dates will be stored in UTC"
|
|
23
|
+
|
|
24
|
+
**Skip ADRs for:**
|
|
25
|
+
- Routine implementation choices
|
|
26
|
+
- Bug fixes
|
|
27
|
+
- Decisions scoped to a single spec (use `04-decisions.md` instead)
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## Workflow
|
|
32
|
+
|
|
33
|
+
### Step 0: Search & Log
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
// turbo
|
|
37
|
+
Call MCP `call_tool_logger_manager` { action: "logWorkflow", name: "/adr", outcome: "success" }
|
|
38
|
+
Call MCP `call_tool_compound_manager` { action: "search", terms: [ "architectural decision"] }
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Step 1: Check Existing ADRs (MANDATORY)
|
|
42
|
+
|
|
43
|
+
> [!CAUTION]
|
|
44
|
+
> **BLOCKING STEP.** Check if this decision has already been made.
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
// turbo
|
|
48
|
+
Call MCP `call_tool_compound_manager` { action: "search", terms: [ "{decision keywords}"] }
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
If an existing ADR covers this decision → Reference it; don't create a duplicate.
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
### Step 1: Get Next ID
|
|
56
|
+
```bash
|
|
57
|
+
// turbo
|
|
58
|
+
next_id=$(printf "%03d" $(( $(ls -1 docs/decisions/*.md 2>/dev/null | xargs -n1 basename | grep -E '^[0-9]{3}-' | wc -l) + 1 )))
|
|
59
|
+
echo "Next ADR ID: $next_id"
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Step 2: Create From Template
|
|
63
|
+
```bash
|
|
64
|
+
cp docs/decisions/adr-template.md docs/decisions/${next_id}-{decision-slug}.md
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Use a descriptive slug, e.g., `002-adopt-graphql-for-external-api.md`
|
|
68
|
+
|
|
69
|
+
### Step 3: Fill Core Sections
|
|
70
|
+
|
|
71
|
+
Open the new file and complete:
|
|
72
|
+
|
|
73
|
+
| Section | Content |
|
|
74
|
+
|---------|---------|
|
|
75
|
+
| **Context** | What problem or situation led to this decision? What constraints exist? |
|
|
76
|
+
| **Decision** | The specific choice made (be authoritative). |
|
|
77
|
+
| **Alternatives** | What else was considered? Why rejected? |
|
|
78
|
+
| **Consequences** | Trade-offs: positive AND negative. |
|
|
79
|
+
|
|
80
|
+
### Step 4: Link to Source
|
|
81
|
+
|
|
82
|
+
Update the `## Related` section:
|
|
83
|
+
- Link to originating `/plan` or `/spec` if applicable
|
|
84
|
+
- Note if this supersedes a previous ADR
|
|
85
|
+
|
|
86
|
+
### Step 5: Update Frontmatter
|
|
87
|
+
|
|
88
|
+
Ensure YAML is valid:
|
|
89
|
+
```yaml
|
|
90
|
+
---
|
|
91
|
+
id: "ADR-{NNN}"
|
|
92
|
+
title: "{Decision Title}"
|
|
93
|
+
date: "YYYY-MM-DD"
|
|
94
|
+
status: "accepted" # or proposed, deprecated, superseded
|
|
95
|
+
tags: [database, api, frontend, infrastructure, patterns, dependencies]
|
|
96
|
+
last_referenced: "YYYY-MM-DD"
|
|
97
|
+
---
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Step 6: Offer Next Steps
|
|
101
|
+
|
|
102
|
+
```
|
|
103
|
+
✓ ADR created: docs/decisions/{next_id}-{slug}.md
|
|
104
|
+
|
|
105
|
+
What's next?
|
|
106
|
+
1. Get review - Share with team for feedback
|
|
107
|
+
2. Link in plan - Reference ADR in your implementation plan
|
|
108
|
+
3. Continue working - Decision is now recorded
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### Phase 5: Completion & Handoff
|
|
112
|
+
|
|
113
|
+
#### Step 1: Establish Terminal UI State
|
|
114
|
+
|
|
115
|
+
```javascript
|
|
116
|
+
await task_boundary({
|
|
117
|
+
TaskName: "[COMPLETED] Create ADR",
|
|
118
|
+
TaskStatus: "ADR created and filed. Offering next steps.",
|
|
119
|
+
Mode: "VERIFICATION",
|
|
120
|
+
TaskSummary: "Created ADR-{NNN}: {Title}. Documented decision context and consequences."
|
|
121
|
+
});
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
#### Step 2: Mandatory Handoff
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
✓ ADR created
|
|
128
|
+
|
|
129
|
+
Next steps:
|
|
130
|
+
1. /plan - Create implementation plan for this decision
|
|
131
|
+
2. /work - Start implementing
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
## Lifecycle Management
|
|
137
|
+
|
|
138
|
+
| Status | Meaning |
|
|
139
|
+
|--------|---------|
|
|
140
|
+
| `proposed` | Under discussion, not yet agreed |
|
|
141
|
+
| `accepted` | Agreed and currently in force |
|
|
142
|
+
| `deprecated` | Guidance to stop using; legacy may exist |
|
|
143
|
+
| `superseded` | Replaced by a newer ADR (link to it) |
|
|
144
|
+
|
|
145
|
+
**To supersede an ADR:**
|
|
146
|
+
1. Create new ADR with updated decision
|
|
147
|
+
2. Add `superseded_by: "ADR-{NNN}"` to old ADR's frontmatter
|
|
148
|
+
3. Change old ADR status to `superseded`
|
|
149
|
+
|
|
150
|
+
---
|
|
151
|
+
|
|
152
|
+
## Quality Guidelines
|
|
153
|
+
|
|
154
|
+
**Good ADRs have:**
|
|
155
|
+
- ✅ Clear context (the "why")
|
|
156
|
+
- ✅ Explicit decision statement
|
|
157
|
+
- ✅ Alternatives with rejection reasons
|
|
158
|
+
- ✅ Honest consequences (including negatives)
|
|
159
|
+
|
|
160
|
+
**Avoid:**
|
|
161
|
+
- ❌ Vague rationale ("seemed better")
|
|
162
|
+
- ❌ Missing alternatives
|
|
163
|
+
- ❌ Only positive consequences listed
|
|
164
|
+
- ❌ Implementation details (that's for plans)
|
|
165
|
+
|
|
166
|
+
---
|
|
167
|
+
|
|
168
|
+
## References
|
|
169
|
+
|
|
170
|
+
- Directory: `docs/decisions/`
|
|
171
|
+
- Template: `docs/decisions/adr-template.md`
|
|
172
|
+
- Search decisions: `Call MCP `call_tool_compound_manager` { action: "search", terms: [] }`
|
|
173
|
+
- Integration: `/plan` Step 5.5 and `/specs` Step 4
|
|
174
|
+
- Standard: [Michael Nygard's ADR format](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions)
|
|
@@ -1,74 +1,74 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: Generate changelog entries from commits. Use before releases.
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
# /changelog - Generate Changelog
|
|
6
|
-
|
|
7
|
-
Create changelog entries from git history automatically using conventional commits.
|
|
8
|
-
|
|
9
|
-
## Workflow
|
|
10
|
-
|
|
11
|
-
### Step 0: Search & Log
|
|
12
|
-
|
|
13
|
-
```bash
|
|
14
|
-
// turbo
|
|
15
|
-
Call MCP `call_tool_logger_manager` { action: "logWorkflow", name: "/changelog", outcome: "success" }
|
|
16
|
-
Call MCP `call_tool_compound_manager` { action: "search", terms: [ "changelog generation"] }
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
### Step 1: Run Generation Script
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
|
-
npm run changelog:gen
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
This script will:
|
|
26
|
-
1. Find the latest git tag
|
|
27
|
-
2. Parse all commits since that tag
|
|
28
|
-
3. Group them by type (feat, fix, docs, etc.)
|
|
29
|
-
4. Prepend a new entry to `CHANGELOG.md`
|
|
30
|
-
|
|
31
|
-
### Step 2: Review and Edit
|
|
32
|
-
|
|
33
|
-
Open `CHANGELOG.md` and review the generated entry:
|
|
34
|
-
|
|
35
|
-
- [ ] Check for duplicate entries
|
|
36
|
-
- [ ] Improve descriptions where needed
|
|
37
|
-
- [ ] Group breaking changes under a "BREAKING CHANGES" section if not auto-detected
|
|
38
|
-
|
|
39
|
-
### Step 3: Commit Changes
|
|
40
|
-
|
|
41
|
-
```bash
|
|
42
|
-
git add CHANGELOG.md
|
|
43
|
-
git commit -m "docs: update changelog"
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
### Phase 5: Completion & Handoff
|
|
47
|
-
|
|
48
|
-
#### Step 1: Establish Terminal UI State
|
|
49
|
-
|
|
50
|
-
```javascript
|
|
51
|
-
await task_boundary({
|
|
52
|
-
TaskName: "[COMPLETED] Generate Changelog",
|
|
53
|
-
TaskStatus: "Changelog generated. Offering next steps.",
|
|
54
|
-
Mode: "VERIFICATION",
|
|
55
|
-
TaskSummary: "Generated changelog for versions {versions}."
|
|
56
|
-
});
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
#### Step 2: Mandatory Handoff
|
|
60
|
-
|
|
61
|
-
```bash
|
|
62
|
-
✓ Changelog updated
|
|
63
|
-
|
|
64
|
-
Next steps:
|
|
65
|
-
1. /release-docs - Prepare release documentation
|
|
66
|
-
2. /housekeeping - Cleanup before push
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
---
|
|
70
|
-
|
|
71
|
-
## References
|
|
72
|
-
|
|
73
|
-
- Implementation: `Call MCP `call_tool_git_manager` { action: "changelog" }`
|
|
74
|
-
- Version documentation: `/release-docs`
|
|
1
|
+
---
|
|
2
|
+
description: Generate changelog entries from commits. Use before releases.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# /changelog - Generate Changelog
|
|
6
|
+
|
|
7
|
+
Create changelog entries from git history automatically using conventional commits.
|
|
8
|
+
|
|
9
|
+
## Workflow
|
|
10
|
+
|
|
11
|
+
### Step 0: Search & Log
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
// turbo
|
|
15
|
+
Call MCP `call_tool_logger_manager` { action: "logWorkflow", name: "/changelog", outcome: "success" }
|
|
16
|
+
Call MCP `call_tool_compound_manager` { action: "search", terms: [ "changelog generation"] }
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### Step 1: Run Generation Script
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm run changelog:gen
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
This script will:
|
|
26
|
+
1. Find the latest git tag
|
|
27
|
+
2. Parse all commits since that tag
|
|
28
|
+
3. Group them by type (feat, fix, docs, etc.)
|
|
29
|
+
4. Prepend a new entry to `CHANGELOG.md`
|
|
30
|
+
|
|
31
|
+
### Step 2: Review and Edit
|
|
32
|
+
|
|
33
|
+
Open `CHANGELOG.md` and review the generated entry:
|
|
34
|
+
|
|
35
|
+
- [ ] Check for duplicate entries
|
|
36
|
+
- [ ] Improve descriptions where needed
|
|
37
|
+
- [ ] Group breaking changes under a "BREAKING CHANGES" section if not auto-detected
|
|
38
|
+
|
|
39
|
+
### Step 3: Commit Changes
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
git add CHANGELOG.md
|
|
43
|
+
git commit -m "docs: update changelog"
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Phase 5: Completion & Handoff
|
|
47
|
+
|
|
48
|
+
#### Step 1: Establish Terminal UI State
|
|
49
|
+
|
|
50
|
+
```javascript
|
|
51
|
+
await task_boundary({
|
|
52
|
+
TaskName: "[COMPLETED] Generate Changelog",
|
|
53
|
+
TaskStatus: "Changelog generated. Offering next steps.",
|
|
54
|
+
Mode: "VERIFICATION",
|
|
55
|
+
TaskSummary: "Generated changelog for versions {versions}."
|
|
56
|
+
});
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
#### Step 2: Mandatory Handoff
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
✓ Changelog updated
|
|
63
|
+
|
|
64
|
+
Next steps:
|
|
65
|
+
1. /release-docs - Prepare release documentation
|
|
66
|
+
2. /housekeeping - Cleanup before push
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## References
|
|
72
|
+
|
|
73
|
+
- Implementation: `Call MCP `call_tool_git_manager` { action: "changelog" }`
|
|
74
|
+
- Version documentation: `/release-docs`
|