@artale/pi-real-engineering 0.2.0 → 0.2.2
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/README.md +70 -59
- package/extensions/real-engineering.ts +27 -6
- package/package.json +1 -1
- package/skills/setup-artale-skills/SKILL.md +50 -50
package/README.md
CHANGED
|
@@ -1,59 +1,70 @@
|
|
|
1
|
-
# @artale/pi-real-engineering
|
|
2
|
-
|
|
3
|
-
Plan → Build → Test → Review → Ship for Pi, with verifier guardrails and receipts.
|
|
4
|
-
|
|
5
|
-
This is not a loose skills pack. It installs one workflow command plus the small skills that make the loop work.
|
|
6
|
-
|
|
7
|
-
## Install
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
pi install npm:@artale/pi-real-engineering
|
|
11
|
-
/reload
|
|
12
|
-
```
|
|
13
|
-
|
|
14
|
-
## Golden path
|
|
15
|
-
|
|
16
|
-
```text
|
|
17
|
-
idea → safety gate → ADW plan/build/test/review → receipt → guarded deploy
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Run it:
|
|
21
|
-
|
|
22
|
-
```text
|
|
23
|
-
/real-engineering build the smallest safe version of <idea>
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
The command makes Pi:
|
|
27
|
-
|
|
28
|
-
1. restate the idea
|
|
29
|
-
2. run a safety gate before risky writes/commands/deploys
|
|
30
|
-
3. plan/build/test/review in the smallest useful loop
|
|
31
|
-
4. produce a receipt: changed files, commands run, test output, review result, deploy decision
|
|
32
|
-
5. deploy only when explicitly requested and verified
|
|
33
|
-
|
|
34
|
-
## Included skills
|
|
35
|
-
|
|
36
|
-
| Skill | Purpose |
|
|
37
|
-
|---|---|
|
|
38
|
-
| `setup-artale-skills` | Create repo conventions: `AGENTS.md`, `CONTEXT.md`, `docs/adr/`, `.pi/plans/` |
|
|
39
|
-
| `grill-with-docs` | Interview against docs/context before implementation |
|
|
40
|
-
| `tdd` | Red-green-refactor one vertical slice at a time |
|
|
41
|
-
| `diagnosing-bugs` | Reproduce, minimize, hypothesize, instrument, fix |
|
|
42
|
-
| `domain-modeling` | Maintain shared language in `CONTEXT.md` and ADRs |
|
|
43
|
-
| `codebase-design` | Design deep modules with small interfaces and clean seams |
|
|
44
|
-
|
|
45
|
-
## Receipt format
|
|
46
|
-
|
|
47
|
-
```md
|
|
48
|
-
## Real Engineering Receipt
|
|
49
|
-
- Idea:
|
|
50
|
-
- Safety gate:
|
|
51
|
-
- Plan:
|
|
52
|
-
- Changed files:
|
|
53
|
-
- Commands run:
|
|
54
|
-
- Test output:
|
|
55
|
-
- Review result:
|
|
56
|
-
- Deploy decision:
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
No new infra. The workflow uses Pi commands, verifier discipline, and your existing deploy path.
|
|
1
|
+
# @artale/pi-real-engineering
|
|
2
|
+
|
|
3
|
+
Plan → Build → Test → Review → Ship for Pi, with verifier guardrails and receipts.
|
|
4
|
+
|
|
5
|
+
This is not a loose skills pack. It installs one workflow command plus the small skills that make the loop work.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pi install npm:@artale/pi-real-engineering
|
|
11
|
+
/reload
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Golden path
|
|
15
|
+
|
|
16
|
+
```text
|
|
17
|
+
idea → safety gate → ADW plan/build/test/review → receipt → guarded deploy
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Run it:
|
|
21
|
+
|
|
22
|
+
```text
|
|
23
|
+
/real-engineering build the smallest safe version of <idea>
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
The command makes Pi:
|
|
27
|
+
|
|
28
|
+
1. restate the idea
|
|
29
|
+
2. run a safety gate before risky writes/commands/deploys
|
|
30
|
+
3. plan/build/test/review in the smallest useful loop
|
|
31
|
+
4. produce a receipt: changed files, commands run, test output, review result, deploy decision
|
|
32
|
+
5. deploy only when explicitly requested and verified
|
|
33
|
+
|
|
34
|
+
## Included skills
|
|
35
|
+
|
|
36
|
+
| Skill | Purpose |
|
|
37
|
+
|---|---|
|
|
38
|
+
| `setup-artale-skills` | Create repo conventions: `AGENTS.md`, `CONTEXT.md`, `docs/adr/`, `.pi/plans/` |
|
|
39
|
+
| `grill-with-docs` | Interview against docs/context before implementation |
|
|
40
|
+
| `tdd` | Red-green-refactor one vertical slice at a time |
|
|
41
|
+
| `diagnosing-bugs` | Reproduce, minimize, hypothesize, instrument, fix |
|
|
42
|
+
| `domain-modeling` | Maintain shared language in `CONTEXT.md` and ADRs |
|
|
43
|
+
| `codebase-design` | Design deep modules with small interfaces and clean seams |
|
|
44
|
+
|
|
45
|
+
## Receipt format
|
|
46
|
+
|
|
47
|
+
```md
|
|
48
|
+
## Real Engineering Receipt
|
|
49
|
+
- Idea:
|
|
50
|
+
- Safety gate:
|
|
51
|
+
- Plan:
|
|
52
|
+
- Changed files:
|
|
53
|
+
- Commands run:
|
|
54
|
+
- Test output:
|
|
55
|
+
- Review result:
|
|
56
|
+
- Deploy decision:
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
No new infra. The workflow uses Pi commands, verifier discipline, and your existing deploy path.
|
|
60
|
+
|
|
61
|
+
## Package aliases
|
|
62
|
+
|
|
63
|
+
Both packages install the same workflow:
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
pi install npm:pi-real-engineering
|
|
67
|
+
pi install npm:@artale/pi-real-engineering
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Prefer `npm:pi-real-engineering` for the short golden path install.
|
|
@@ -8,12 +8,33 @@ export default function (pi: ExtensionAPI) {
|
|
|
8
8
|
Golden path:
|
|
9
9
|
idea → safety gate → ADW plan/build/test/review → receipt → guarded deploy
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
11
|
+
Safety gate:
|
|
12
|
+
- Identify writes, deletes, network calls, deploys, secret access, and shell commands before doing them.
|
|
13
|
+
- Ask before dangerous or irreversible actions.
|
|
14
|
+
- Stop if the requested outcome is unclear.
|
|
15
|
+
|
|
16
|
+
ADW loop:
|
|
17
|
+
1. Plan the smallest useful change.
|
|
18
|
+
2. Build only that change.
|
|
19
|
+
3. Test with one command that would fail if the change broke.
|
|
20
|
+
4. Review the diff as if you did not write it.
|
|
21
|
+
5. Ship/deploy only when explicitly requested and verified.
|
|
22
|
+
|
|
23
|
+
Verifier rule:
|
|
24
|
+
- PASS only when checks actually ran.
|
|
25
|
+
- If tests, runtime, publish/install, or deploy state are not verified, say ISSUES/Unverifiable.
|
|
26
|
+
|
|
27
|
+
Receipt required:
|
|
28
|
+
## Real Engineering Receipt
|
|
29
|
+
- Idea:
|
|
30
|
+
- Safety gate:
|
|
31
|
+
- Plan:
|
|
32
|
+
- Changed files:
|
|
33
|
+
- Commands run:
|
|
34
|
+
- Test output:
|
|
35
|
+
- Review result:
|
|
36
|
+
- Deploy decision:
|
|
37
|
+
- Residual risks:
|
|
17
38
|
|
|
18
39
|
Start by restating the idea and the safety gate.`,
|
|
19
40
|
});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@artale/pi-real-engineering",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
4
4
|
"description": "Real Engineering Workflow for Pi: Plan \u2192 Build \u2192 Test \u2192 Review \u2192 Ship with verifier guardrails and receipts.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -1,50 +1,50 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: setup-artale-skills
|
|
3
|
-
description: Configure a repo for Artale real-engineering skills: AGENTS.md rules, issue workflow, CONTEXT.md, ADRs, and .pi/plans. User-invoked setup procedure.
|
|
4
|
-
disable-model-invocation: true
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Setup Artale Skills
|
|
8
|
-
|
|
9
|
-
Prompt-driven setup. Explore first, ask before writing, then make the smallest durable conventions.
|
|
10
|
-
|
|
11
|
-
## Explore
|
|
12
|
-
|
|
13
|
-
Check:
|
|
14
|
-
|
|
15
|
-
- `git remote -v` / `.git/config`
|
|
16
|
-
- `AGENTS.md`, `CLAUDE.md`
|
|
17
|
-
- `CONTEXT.md`, `CONTEXT-MAP.md`
|
|
18
|
-
- `docs/adr/`
|
|
19
|
-
- `docs/agents/`
|
|
20
|
-
- `.pi/plans/`
|
|
21
|
-
|
|
22
|
-
## Ask one decision at a time
|
|
23
|
-
|
|
24
|
-
1. **Issue workflow**: GitHub (`gh`), GitLab (`glab`), local markdown, or other.
|
|
25
|
-
2. **Docs layout**: single-context `CONTEXT.md` or multi-context `CONTEXT-MAP.md`.
|
|
26
|
-
3. **Verifier strictness**: strict by default; PASS requires real checks.
|
|
27
|
-
|
|
28
|
-
## Write
|
|
29
|
-
|
|
30
|
-
Prefer `AGENTS.md`. If only `CLAUDE.md` exists, update it for compatibility. Do not create both unless the user asks.
|
|
31
|
-
|
|
32
|
-
Create lazily:
|
|
33
|
-
|
|
34
|
-
- `CONTEXT.md`
|
|
35
|
-
- `docs/adr/`
|
|
36
|
-
- `.pi/plans/`
|
|
37
|
-
- `docs/agents/issue-tracker.md`
|
|
38
|
-
- `docs/agents/domain.md`
|
|
39
|
-
|
|
40
|
-
## Agent skills block
|
|
41
|
-
|
|
42
|
-
```md
|
|
43
|
-
## Agent skills
|
|
44
|
-
|
|
45
|
-
- Use `CONTEXT.md` for domain language before planning.
|
|
46
|
-
- Use `docs/adr/` for durable architectural decisions.
|
|
47
|
-
- Use `.pi/plans/` for temporary plans/spikes.
|
|
48
|
-
- Use `tdd` for behavior changes, `diagnosing-bugs` for bugs, `codebase-design` for module/interface work.
|
|
49
|
-
- Do not return PASS unless checks actually ran.
|
|
50
|
-
```
|
|
1
|
+
---
|
|
2
|
+
name: setup-artale-skills
|
|
3
|
+
description: "Configure a repo for Artale real-engineering skills: AGENTS.md rules, issue workflow, CONTEXT.md, ADRs, and .pi/plans. User-invoked setup procedure."
|
|
4
|
+
disable-model-invocation: true
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Setup Artale Skills
|
|
8
|
+
|
|
9
|
+
Prompt-driven setup. Explore first, ask before writing, then make the smallest durable conventions.
|
|
10
|
+
|
|
11
|
+
## Explore
|
|
12
|
+
|
|
13
|
+
Check:
|
|
14
|
+
|
|
15
|
+
- `git remote -v` / `.git/config`
|
|
16
|
+
- `AGENTS.md`, `CLAUDE.md`
|
|
17
|
+
- `CONTEXT.md`, `CONTEXT-MAP.md`
|
|
18
|
+
- `docs/adr/`
|
|
19
|
+
- `docs/agents/`
|
|
20
|
+
- `.pi/plans/`
|
|
21
|
+
|
|
22
|
+
## Ask one decision at a time
|
|
23
|
+
|
|
24
|
+
1. **Issue workflow**: GitHub (`gh`), GitLab (`glab`), local markdown, or other.
|
|
25
|
+
2. **Docs layout**: single-context `CONTEXT.md` or multi-context `CONTEXT-MAP.md`.
|
|
26
|
+
3. **Verifier strictness**: strict by default; PASS requires real checks.
|
|
27
|
+
|
|
28
|
+
## Write
|
|
29
|
+
|
|
30
|
+
Prefer `AGENTS.md`. If only `CLAUDE.md` exists, update it for compatibility. Do not create both unless the user asks.
|
|
31
|
+
|
|
32
|
+
Create lazily:
|
|
33
|
+
|
|
34
|
+
- `CONTEXT.md`
|
|
35
|
+
- `docs/adr/`
|
|
36
|
+
- `.pi/plans/`
|
|
37
|
+
- `docs/agents/issue-tracker.md`
|
|
38
|
+
- `docs/agents/domain.md`
|
|
39
|
+
|
|
40
|
+
## Agent skills block
|
|
41
|
+
|
|
42
|
+
```md
|
|
43
|
+
## Agent skills
|
|
44
|
+
|
|
45
|
+
- Use `CONTEXT.md` for domain language before planning.
|
|
46
|
+
- Use `docs/adr/` for durable architectural decisions.
|
|
47
|
+
- Use `.pi/plans/` for temporary plans/spikes.
|
|
48
|
+
- Use `tdd` for behavior changes, `diagnosing-bugs` for bugs, `codebase-design` for module/interface work.
|
|
49
|
+
- Do not return PASS unless checks actually ran.
|
|
50
|
+
```
|