create-agentic-pdlc 2.0.0 β 2.0.1
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/.github/CODEOWNERS +5 -0
- package/AGENTS.md +8 -7
- package/bin/cli.js +4 -2
- package/docs/flow.md +29 -16
- package/package.json +2 -2
- package/templates/AGENTS.md +8 -7
package/AGENTS.md
CHANGED
|
@@ -27,13 +27,14 @@ Always start from the current `main` HEAD. Never work over stale snapshots.
|
|
|
27
27
|
## Mandatory Workflow
|
|
28
28
|
|
|
29
29
|
0. **Identity**: Always prefix your GitHub comments with `π€ **Agent:** ` to distinguish yourself.
|
|
30
|
-
1.
|
|
31
|
-
2. Read
|
|
32
|
-
3. Read
|
|
33
|
-
4.
|
|
34
|
-
5.
|
|
35
|
-
6. Run
|
|
36
|
-
7.
|
|
30
|
+
1. **Initial State**: When beginning work on a new issue, your very first action must be to apply the `stage:exploration` label using the GitHub CLI (`gh issue edit <N> --add-label "stage:exploration"`).
|
|
31
|
+
2. Read the issue entirely β understand its type (US/BUG/TASK/SPIKE) and the Acceptance Criteria.
|
|
32
|
+
3. Read `docs/pdlc.md` β understand the PDLC and the Definition of Done in this project.
|
|
33
|
+
4. Read all files mentioned in the issue's technical context.
|
|
34
|
+
5. Implement the **minimum viable change** that satisfies the ACs β do not refactor beyond scope.
|
|
35
|
+
6. Run tests: `echo "No tests/build needed."`
|
|
36
|
+
7. Run typecheck: `echo "No typecheck needed."`
|
|
37
|
+
8. Create a Pull Request with `Closes #N` in the body β automation moves the board.
|
|
37
38
|
|
|
38
39
|
## What NOT to do
|
|
39
40
|
|
package/bin/cli.js
CHANGED
|
@@ -63,8 +63,10 @@ rl.question('Which AI Agent will you use for the setup? (e.g. claude, cursor, co
|
|
|
63
63
|
fs.copyFileSync(claudeSetupSrc, dest);
|
|
64
64
|
console.log(`β
Setup agent profile written to .agentic-setup.md`);
|
|
65
65
|
console.log(`\n${green}π Done! To start the conversational setup:${reset}`);
|
|
66
|
-
console.log(`${cyan}\
|
|
67
|
-
console.log(`${cyan}\
|
|
66
|
+
console.log(`${cyan}\tStep 1: Open the Claude Code CLI in your terminal (type 'claude')${reset}`);
|
|
67
|
+
console.log(`${cyan}\t [Or open your preferred IDE Agent chat, like Antigravity, Cursor, Codex, GitHub Copilot, etc]${reset}`);
|
|
68
|
+
console.log(`${cyan}\tStep 2: Paste this exact prompt:${reset}`);
|
|
69
|
+
console.log(`${yellow}\t "read .agentic-setup.md to enter Setup Mode."${reset}`);
|
|
68
70
|
console.log(`\nNote: Once setup is completed, the agent will typically delete .agentic-setup.md to keep your root clean.\n`);
|
|
69
71
|
} else {
|
|
70
72
|
console.error(`β Could not find claude instruction file at ${claudeSetupSrc}`);
|
package/docs/flow.md
CHANGED
|
@@ -2,6 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
This document describes the full lifecycle of a card on the agentic-pdlc board β who acts at each stage, what triggers each transition, which labels are added or removed, and where human gates are required.
|
|
4
4
|
|
|
5
|
+
```mermaid
|
|
6
|
+
stateDiagram-v2
|
|
7
|
+
direction LR
|
|
8
|
+
Idea --> Exploration : stage:exploration
|
|
9
|
+
Exploration --> Brainstorming : stage:brainstorming
|
|
10
|
+
Brainstorming --> Detailing : Gate 1 (PM)
|
|
11
|
+
Detailing --> Approval : stage:approval
|
|
12
|
+
Approval --> Development : Gate 2 (spec:approved)
|
|
13
|
+
Development --> Testing : stage:testing
|
|
14
|
+
Testing --> CodeReview : PR Opened
|
|
15
|
+
CodeReview --> Production : Gate 3 (PR Merged)
|
|
16
|
+
```
|
|
17
|
+
|
|
5
18
|
---
|
|
6
19
|
|
|
7
20
|
## Roles
|
|
@@ -21,17 +34,17 @@ This document describes the full lifecycle of a card on the agentic-pdlc board
|
|
|
21
34
|
## Step-by-Step Flow
|
|
22
35
|
|
|
23
36
|
### π‘ Idea
|
|
24
|
-
Issue exists in the backlog with no `
|
|
37
|
+
Issue exists in the backlog with no `stage:` label.
|
|
25
38
|
|
|
26
39
|
---
|
|
27
40
|
|
|
28
41
|
### π Exploration
|
|
29
42
|
|
|
30
43
|
**Trigger (two equivalent paths):**
|
|
31
|
-
- PM tells Claude directly in chat β Claude adds `
|
|
32
|
-
- PM adds `
|
|
44
|
+
- PM tells Claude directly in chat β Claude adds `stage:exploration` to the issue, OR
|
|
45
|
+
- PM adds `stage:exploration` directly to the issue
|
|
33
46
|
|
|
34
|
-
**Workflow:** `project-automation.yml` detects `
|
|
47
|
+
**Workflow:** `project-automation.yml` detects `stage:exploration` β moves card to Exploration.
|
|
35
48
|
|
|
36
49
|
**Who works:** Claude reads relevant code and context.
|
|
37
50
|
|
|
@@ -43,7 +56,7 @@ Issue exists in the backlog with no `upstream:` label.
|
|
|
43
56
|
|
|
44
57
|
**Actions:**
|
|
45
58
|
- Claude posts a comment on the issue with findings and 2β3 proposed approaches
|
|
46
|
-
- Claude swaps `
|
|
59
|
+
- Claude swaps `stage:exploration` β `stage:brainstorming`
|
|
47
60
|
|
|
48
61
|
**Workflow:** `project-automation.yml` moves card to Brainstorming.
|
|
49
62
|
|
|
@@ -57,14 +70,14 @@ Issue exists in the backlog with no `upstream:` label.
|
|
|
57
70
|
|
|
58
71
|
### π Detail Solution β Gate 1
|
|
59
72
|
|
|
60
|
-
**Trigger:** `upstream-gate.yml` detects PM approval comment on a `
|
|
73
|
+
**Trigger:** `upstream-gate.yml` detects PM approval comment on a `stage:brainstorming` issue β swaps `stage:brainstorming` β `stage:detailing` via `PROJECT_TOKEN`.
|
|
61
74
|
|
|
62
75
|
**Who works:** Claude rewrites the issue body with:
|
|
63
76
|
1. User story (`Asβ¦ I wantβ¦ So thatβ¦`)
|
|
64
77
|
2. Acceptance Criteria (AC1, AC2, β¦)
|
|
65
78
|
3. Files to modify
|
|
66
79
|
|
|
67
|
-
**After spec is written:** Claude swaps `
|
|
80
|
+
**After spec is written:** Claude swaps `stage:detailing` β `stage:approval`.
|
|
68
81
|
|
|
69
82
|
**Workflow:** `project-automation.yml` moves card to Approval.
|
|
70
83
|
|
|
@@ -75,8 +88,8 @@ Issue exists in the backlog with no `upstream:` label.
|
|
|
75
88
|
**βΈ Human gate (Gate 2 β PM + TL):** Both PM (business decisions) and TL (technical decisions) review the spec. When both are satisfied, PM adds label `spec:approved`.
|
|
76
89
|
|
|
77
90
|
**Workflow:** `agent-trigger.yml` detects `spec:approved` β
|
|
78
|
-
1. Removes `
|
|
79
|
-
2. Adds `
|
|
91
|
+
1. Removes `stage:approval`
|
|
92
|
+
2. Adds `stage:development`
|
|
80
93
|
3. Adds specific agent label (e.g., `jules`)
|
|
81
94
|
4. Posts a structured comment with implementation instructions for the Agent
|
|
82
95
|
|
|
@@ -88,7 +101,7 @@ Issue exists in the backlog with no `upstream:` label.
|
|
|
88
101
|
|
|
89
102
|
**Who works:** Implementation Agent implements the spec strictly within the Acceptance Criteria.
|
|
90
103
|
|
|
91
|
-
**When done:** Agent adds `
|
|
104
|
+
**When done:** Agent adds `stage:testing` before running tests.
|
|
92
105
|
|
|
93
106
|
**Workflow:** `project-automation.yml` moves card to Testing.
|
|
94
107
|
|
|
@@ -128,12 +141,12 @@ Issue exists in the backlog with no `upstream:` label.
|
|
|
128
141
|
|
|
129
142
|
| Label | Added by | Removed by |
|
|
130
143
|
|-------|----------|------------|
|
|
131
|
-
| `
|
|
132
|
-
| `
|
|
133
|
-
| `
|
|
134
|
-
| `
|
|
135
|
-
| `
|
|
136
|
-
| `
|
|
144
|
+
| `stage:exploration` | PM (human) or Claude | Claude |
|
|
145
|
+
| `stage:brainstorming` | Claude | `upstream-gate.yml` |
|
|
146
|
+
| `stage:detailing` | `upstream-gate.yml` | Claude |
|
|
147
|
+
| `stage:approval` | Claude | `agent-trigger.yml` |
|
|
148
|
+
| `stage:development` | `agent-trigger.yml` | Impl. Agent |
|
|
149
|
+
| `stage:testing` | Impl. Agent | `project-automation.yml` (on PR open) |
|
|
137
150
|
| `spec:approved` | PM (human) | β |
|
|
138
151
|
| `agent_label` (e.g. `jules`, `sweep`) | `agent-trigger.yml` | β |
|
|
139
152
|
| `pr:in-review` | `project-automation.yml` | `project-automation.yml` |
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-agentic-pdlc",
|
|
3
|
-
"version": "2.0.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "2.0.1",
|
|
4
|
+
"description": "Agentic PDLC Framework - Conversational setup for your AI coding assistants",
|
|
5
5
|
"type": "commonjs",
|
|
6
6
|
"bin": {
|
|
7
7
|
"create-agentic-pdlc": "./bin/cli.js"
|
package/templates/AGENTS.md
CHANGED
|
@@ -30,13 +30,14 @@ Always start from the current `main` HEAD. Never work over stale snapshots.
|
|
|
30
30
|
## Mandatory Workflow
|
|
31
31
|
|
|
32
32
|
0. **Identity**: Always prefix your GitHub comments with `π€ **Agent:** ` to distinguish yourself.
|
|
33
|
-
1.
|
|
34
|
-
2. Read
|
|
35
|
-
3. Read
|
|
36
|
-
4.
|
|
37
|
-
5.
|
|
38
|
-
6. Run
|
|
39
|
-
7.
|
|
33
|
+
1. **Initial State**: When beginning work on a new issue, your very first action must be to apply the `stage:exploration` label using the GitHub CLI (`gh issue edit <N> --add-label "stage:exploration"`).
|
|
34
|
+
2. Read the issue entirely β understand its type (US/BUG/TASK/SPIKE) and the Acceptance Criteria.
|
|
35
|
+
3. Read `docs/pdlc.md` β understand the PDLC and the Definition of Done in this project.
|
|
36
|
+
4. Read all files mentioned in the issue's technical context.
|
|
37
|
+
5. Implement the **minimum viable change** that satisfies the ACs β do not refactor beyond scope.
|
|
38
|
+
6. Run tests: `{{TEST_COMMAND}}`
|
|
39
|
+
7. Run typecheck (if applicable): `{{TYPECHECK_COMMAND}}`
|
|
40
|
+
8. Create a Pull Request with `Closes #N` in the body β automation moves the board.
|
|
40
41
|
|
|
41
42
|
### Spec format (Upstream Agents)
|
|
42
43
|
|