@rasensio/aidlc 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +5 -2
- package/skills/01-getting-started.md +127 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rasensio/aidlc",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "AI Development Lifecycle Framework — structured lifecycle guidance for AI coding agents across platforms",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/cli.js",
|
|
@@ -15,7 +15,10 @@
|
|
|
15
15
|
"test": "vitest run",
|
|
16
16
|
"test:watch": "vitest",
|
|
17
17
|
"lint": "tsc --noEmit",
|
|
18
|
-
"prepublishOnly": "npm run build && npm test"
|
|
18
|
+
"prepublishOnly": "npm run build && npm test",
|
|
19
|
+
"release:patch": "npm version patch && npm publish --access public && git push --follow-tags",
|
|
20
|
+
"release:minor": "npm version minor && npm publish --access public && git push --follow-tags",
|
|
21
|
+
"release:major": "npm version major && npm publish --access public && git push --follow-tags"
|
|
19
22
|
},
|
|
20
23
|
"keywords": [
|
|
21
24
|
"ai",
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: aidlc-getting-started
|
|
3
|
+
description: Helps users get started with AIDLC — responds to onboarding questions, suggests templates, and guides first steps
|
|
4
|
+
phase: ideation
|
|
5
|
+
priority: 95
|
|
6
|
+
trigger: When the user asks how to get started, how to use the framework, or asks about fixing bugs, adding features, or beginning work
|
|
7
|
+
---
|
|
8
|
+
# Getting Started with AIDLC
|
|
9
|
+
|
|
10
|
+
## When to Activate
|
|
11
|
+
|
|
12
|
+
Respond using this skill when the user asks any of the following:
|
|
13
|
+
- "How do I get started?"
|
|
14
|
+
- "How do I fix a bug?"
|
|
15
|
+
- "How do I add a feature?"
|
|
16
|
+
- "What should I do first?"
|
|
17
|
+
- "How does this lifecycle thing work?"
|
|
18
|
+
- "What template should I use?"
|
|
19
|
+
- "Help me start working on X"
|
|
20
|
+
|
|
21
|
+
## Quick Answers
|
|
22
|
+
|
|
23
|
+
### "How do I fix a bug?"
|
|
24
|
+
|
|
25
|
+
1. Start a bugfix lifecycle instance:
|
|
26
|
+
```
|
|
27
|
+
aidlc start bugfix --name <short-description>
|
|
28
|
+
```
|
|
29
|
+
2. This creates a focused workflow: reproduce the bug → fix it → test it → deploy.
|
|
30
|
+
3. Run `aidlc continue <name>` to see what step to do next.
|
|
31
|
+
4. The bugfix template skips the design phase and requires a `reproduction.md` artifact first.
|
|
32
|
+
|
|
33
|
+
### "How do I add a feature?"
|
|
34
|
+
|
|
35
|
+
For a small, well-defined feature:
|
|
36
|
+
```
|
|
37
|
+
aidlc start quick-feature --name <feature-name>
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
For a larger feature needing design and review:
|
|
41
|
+
```
|
|
42
|
+
aidlc start full-feature --name <feature-name>
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
For something tiny (just code + test):
|
|
46
|
+
```
|
|
47
|
+
aidlc start micro-task --name <task-name>
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### "How do I explore an idea or do research?"
|
|
51
|
+
|
|
52
|
+
```
|
|
53
|
+
aidlc start spike --name <research-topic>
|
|
54
|
+
```
|
|
55
|
+
This gives you Ideation + Requirements phases only — no implementation pressure.
|
|
56
|
+
|
|
57
|
+
### "What should I do next?"
|
|
58
|
+
|
|
59
|
+
Run:
|
|
60
|
+
```
|
|
61
|
+
aidlc continue
|
|
62
|
+
```
|
|
63
|
+
This tells you exactly which artifact to produce or which phase to enter next.
|
|
64
|
+
|
|
65
|
+
### "How do I check progress?"
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
aidlc status
|
|
69
|
+
```
|
|
70
|
+
Shows all active lifecycle instances with completion %, current phase, and stall detection.
|
|
71
|
+
|
|
72
|
+
### "How does the lifecycle work?"
|
|
73
|
+
|
|
74
|
+
AIDLC guides your work through phases:
|
|
75
|
+
|
|
76
|
+
1. **Ideation** — What are we building and why?
|
|
77
|
+
2. **Requirements** — What are the acceptance criteria?
|
|
78
|
+
3. **Design** — How will we build it?
|
|
79
|
+
4. **Implementation** — Write the code
|
|
80
|
+
5. **Testing** — Verify it works
|
|
81
|
+
6. **Deployment** — Ship it
|
|
82
|
+
7. **Maintenance** — Keep it running
|
|
83
|
+
|
|
84
|
+
Not every task needs all phases. The templates handle this:
|
|
85
|
+
- **micro-task** → Implementation + Testing only
|
|
86
|
+
- **quick-feature** → Requirements through Deployment
|
|
87
|
+
- **full-feature** → All 7 phases with review gates
|
|
88
|
+
- **bugfix** → Requirements (reproduction) + Implementation + Testing + Deployment
|
|
89
|
+
- **spike** → Ideation + Requirements (research) only
|
|
90
|
+
|
|
91
|
+
### "How do I set up AIDLC in this project?"
|
|
92
|
+
|
|
93
|
+
If AIDLC is already installed (you can see `.aidlc/skills/` in the project), just start using it:
|
|
94
|
+
```
|
|
95
|
+
aidlc start <template>
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
If not installed yet:
|
|
99
|
+
```
|
|
100
|
+
aidlc setup
|
|
101
|
+
```
|
|
102
|
+
This runs an interactive wizard that configures the framework for your project.
|
|
103
|
+
|
|
104
|
+
## Choosing the Right Template
|
|
105
|
+
|
|
106
|
+
| You want to... | Use this template | Scope |
|
|
107
|
+
|---------------|-------------------|-------|
|
|
108
|
+
| Fix a bug | `bugfix` | Standard (no design) |
|
|
109
|
+
| Add a small feature | `quick-feature` | Standard |
|
|
110
|
+
| Build something complex | `full-feature` | Full (with review gates) |
|
|
111
|
+
| Just write code + test | `micro-task` | Micro |
|
|
112
|
+
| Research / explore | `spike` | Ideation + Requirements |
|
|
113
|
+
|
|
114
|
+
## After Starting
|
|
115
|
+
|
|
116
|
+
Once you've started an instance, the framework tracks your progress. At any point:
|
|
117
|
+
- `aidlc continue` — what to do next
|
|
118
|
+
- `aidlc status` — overall progress
|
|
119
|
+
- `aidlc gate <instance> <phase>` — check if a phase is complete
|
|
120
|
+
- `aidlc transition <instance>` — advance to the next phase
|
|
121
|
+
|
|
122
|
+
## State Location
|
|
123
|
+
|
|
124
|
+
All lifecycle state lives in `.aidlc/state/<instance-name>/`. It's just YAML files — you can read them directly if needed. The key files are:
|
|
125
|
+
- `instance.yaml` — which template, scope, and current phase
|
|
126
|
+
- `phase-<name>.yaml` — artifact completion for each phase
|
|
127
|
+
- `transitions.log` — history of phase transitions
|