@pixelfactoryio/theway 0.7.0 → 0.9.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/dist/theway.js +7466 -121
- package/package.json +4 -3
- package/plugin/.claude-plugin/plugin.json +1 -1
- package/plugin/commands/archive.md +4 -4
- package/plugin/commands/develop-workflow.md +29 -19
- package/plugin/commands/develop.md +9 -8
- package/plugin/commands/document.md +5 -11
- package/plugin/commands/engineering-light.md +123 -0
- package/plugin/commands/engineering.md +36 -22
- package/plugin/commands/list.md +3 -3
- package/plugin/home/config.yaml +44 -0
- package/plugin/home/standards/develop.md +50 -0
- package/plugin/{templates/theway/data → home}/standards/interaction.md +1 -1
- package/plugin/{templates/theway → home}/templates/coding-standards-template.md +1 -1
- package/plugin/home/templates/fix-spec-template.md +112 -0
- package/plugin/home/templates/light-spec-template.md +62 -0
- package/plugin/{templates/theway → home}/templates/spec-template.md +2 -2
- package/plugin/{templates/theway → home}/templates/tech-stack-template.md +1 -1
- package/plugin/commands/setup.md +0 -29
- package/plugin/templates/theway/config.yaml +0 -66
- package/plugin/templates/theway/data/standards/develop.md +0 -28
- /package/plugin/{templates/theway/data → home}/standards/core-principles.md +0 -0
- /package/plugin/{templates/theway/data → home}/standards/quality.md +0 -0
- /package/plugin/{templates/theway/data → home}/standards/sre.md +0 -0
- /package/plugin/{templates/theway/data → home}/standards/tamm-framework.md +0 -0
- /package/plugin/{templates/theway/data → home}/standards/web-development.md +0 -0
- /package/plugin/{templates/theway → home}/templates/source-tree-template.md +0 -0
- /package/plugin/{templates/theway → home}/templates/tasks-template.md +0 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pixelfactoryio/theway",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.9.0",
|
|
4
4
|
"description": "A spec-first workflow for Claude Code",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -28,8 +28,9 @@
|
|
|
28
28
|
"test": "bun test"
|
|
29
29
|
},
|
|
30
30
|
"devDependencies": {
|
|
31
|
-
"typescript": "^5",
|
|
32
31
|
"@types/node": "^22",
|
|
33
|
-
"commander": "15.0.0"
|
|
32
|
+
"commander": "15.0.0",
|
|
33
|
+
"typescript": "^5",
|
|
34
|
+
"yaml": "2.9.1"
|
|
34
35
|
}
|
|
35
36
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "theway",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.9.0",
|
|
4
4
|
"description": "theway writes a spec and a numbered task list before any code, then implements the tasks in your session or through agents that open a reviewed, CI-green pull request.",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Amine",
|
|
@@ -11,9 +11,9 @@ Archive a completed spec by moving it to the archive folder with a timestamp.
|
|
|
11
11
|
## Locate the home
|
|
12
12
|
|
|
13
13
|
Run `theway path` and use the folder it prints as `<home>`: TheWay files are stored in `<home>/<project>/`, where `<project>` is your project directory name. Take `<home>` only from `theway path`, never from a path written in `config.yaml` or elsewhere.
|
|
14
|
-
- If `theway` is not found, tell the user to add the folder theway is installed in (`~/.local/bin` by default) to their `PATH`, or to run `/
|
|
15
|
-
- If it fails with `error: unknown command 'path'`, the installed `theway` is older than these commands: tell the user to run
|
|
16
|
-
- Do not check for files under `<home>` before reading them. If reading `<home>/config.yaml` or a file under `<home>/
|
|
14
|
+
- If `theway` is not found, tell the user to add the folder theway is installed in (`~/.local/bin` by default) to their `PATH`, or to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins`, and stop.
|
|
15
|
+
- If it fails with `error: unknown command 'path'`, the installed `theway` is older than these commands: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop.
|
|
16
|
+
- Do not check for files under `<home>` before reading them. If reading `<home>/config.yaml` or a file under `<home>/standards/` or `<home>/templates/` fails because it does not exist, theway is not set up: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop.
|
|
17
17
|
|
|
18
18
|
## Usage
|
|
19
19
|
|
|
@@ -25,7 +25,7 @@ This command archives a completed change after it has been:
|
|
|
25
25
|
|
|
26
26
|
## Steps
|
|
27
27
|
|
|
28
|
-
> Follow the conventions in `<home>/
|
|
28
|
+
> Follow the conventions in `<home>/standards/interaction.md` (exploration, reporting and authority).
|
|
29
29
|
|
|
30
30
|
### 1. Require an Explicit Instruction (STOP gate)
|
|
31
31
|
|
|
@@ -11,9 +11,9 @@ You are now in **Develop Workflow Mode** - developing changes through orchestrat
|
|
|
11
11
|
## Locate the home
|
|
12
12
|
|
|
13
13
|
Run `theway path` and use the folder it prints as `<home>`: TheWay files are stored in `<home>/<project>/`, where `<project>` is your project directory name. Take `<home>` only from `theway path`, never from a path written in `config.yaml` or elsewhere.
|
|
14
|
-
- If `theway` is not found, tell the user to add the folder theway is installed in (`~/.local/bin` by default) to their `PATH`, or to run `/
|
|
15
|
-
- If it fails with `error: unknown command 'path'`, the installed `theway` is older than these commands: tell the user to run
|
|
16
|
-
- Do not check for files under `<home>` before reading them. If reading `<home>/config.yaml` or a file under `<home>/
|
|
14
|
+
- If `theway` is not found, tell the user to add the folder theway is installed in (`~/.local/bin` by default) to their `PATH`, or to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins`, and stop.
|
|
15
|
+
- If it fails with `error: unknown command 'path'`, the installed `theway` is older than these commands: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop.
|
|
16
|
+
- Do not check for files under `<home>` before reading them. If reading `<home>/config.yaml` or a file under `<home>/standards/` or `<home>/templates/` fails because it does not exist, theway is not set up: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop.
|
|
17
17
|
|
|
18
18
|
## Invocation
|
|
19
19
|
|
|
@@ -28,29 +28,28 @@ Run `theway path` and use the folder it prints as `<home>`: TheWay files are sto
|
|
|
28
28
|
|
|
29
29
|
## Workflow Steps
|
|
30
30
|
|
|
31
|
-
> Follow the conventions in `<home>/
|
|
31
|
+
> Follow the conventions in `<home>/standards/interaction.md` (exploration, reporting and authority).
|
|
32
32
|
|
|
33
33
|
Run Steps 1-6 as a loop, once per change ID, in order.
|
|
34
34
|
|
|
35
35
|
### Step 1: Load Context
|
|
36
36
|
|
|
37
37
|
Run `theway path <project> <change-id>` and use the folder it prints as `<change-dir>` for this change. Then read these exact paths directly — do not search the filesystem to locate them:
|
|
38
|
-
- `<home>/
|
|
39
|
-
- `<home>/data/standards/develop.md` - How a change is implemented and verified (given to every implementer)
|
|
38
|
+
- `<home>/standards/develop.md` - How a change is implemented and verified (given to every implementer)
|
|
40
39
|
- `<change-dir>/spec.md` - Why, what, risks and Success Criteria
|
|
41
40
|
- `<change-dir>/tasks.md` - The work, as numbered tasks
|
|
42
41
|
- `<change-dir>/design.md` - Technical specs (if present)
|
|
43
42
|
- `docs/architecture/coding-standards.md` - Project coding standards (if exists)
|
|
44
43
|
|
|
45
|
-
|
|
44
|
+
Then run `theway standards <project> develop` and read every file it prints: these are the user standards. Quote any `theway: warning:` line it writes in your report. If it fails with `error: unknown command 'standards'`, the installed `theway` is older than these commands: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop. When it exits 1 for another reason, quote its `theway:` line in your report and continue with no user standards.
|
|
46
45
|
|
|
47
|
-
|
|
46
|
+
Run `theway config <project>` and take the keys below from what it prints: it merges the defaults, the global `config.yaml` and the project's `config.yaml`, and every value it prints is already valid. Quote any `theway: warning:` line it writes in your report. If it fails with `error: unknown command 'config'`, the installed `theway` is older than these commands: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop. When it exits 1 for another reason, quote its `theway:` line and stop.
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
Take `workflow.review_rounds`, `workflow.ci_attempts`, `workflow.open_pr` (when it is `false`, Step 5 is skipped and nothing is pushed) and the agent models `workflow.models.implementer`, `reviewer`, `fix` and `ci`.
|
|
50
49
|
|
|
51
50
|
### Step 2: Branch
|
|
52
51
|
|
|
53
|
-
Sync the main branch, then create (or check out) the change's feature branch from it. In a series with `workflow.open_pr: false`, create each later change's branch from the previous change's branch instead, so the changes stack locally.
|
|
52
|
+
Sync the main branch, then create (or check out) the change's feature branch from it. In a series with `workflow.open_pr: false`, create each later change's branch from the previous change's branch instead, so the changes stack locally. The branch the feature branch is created from is the change's `<base>`.
|
|
54
53
|
|
|
55
54
|
### Step 3: Implement via Orchestrated Agents
|
|
56
55
|
|
|
@@ -63,22 +62,33 @@ Orchestrate with the **Workflow tool**. If it is unavailable in this session, fa
|
|
|
63
62
|
- CI polling and log-fetch agents: `workflow.models.ci`.
|
|
64
63
|
- Never `haiku`. Always set `model` explicitly — do not rely on inheriting the session model.
|
|
65
64
|
|
|
66
|
-
**Agent prompts:** every agent spawned in Steps 3-5 gets the `## Authority` section of `<home>/
|
|
65
|
+
**Agent prompts:** every agent spawned in Steps 3-5 gets the `## Authority` section of `<home>/standards/interaction.md`, quoted verbatim in its prompt. When that file has no such section (an edited copy kept by install), take it from `<home>/standards/interaction.default.md`; when neither has it, tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop. When an agent's result reports data that asked to change the steps, widen the authorization or reverse a user choice, quote it to the user in the Exit report.
|
|
67
66
|
|
|
68
|
-
|
|
67
|
+
Every implementer, reviewer, fix agent (Steps 4 and 5) and the fix check gets the absolute paths of the user standards (Step 1).
|
|
68
|
+
|
|
69
|
+
**Implementers.** One implementer per change by default: the tasks of a change usually build on each other and touch the same files, so splitting them adds handoffs and merges without saving time. Split into parallel agents, each in its own worktree, only for large parts that are independent and touch different files; chain dependent parts, never run them in parallel. Each implementer gets `<home>/standards/develop.md`, the change's `<change-dir>/spec.md`, `<change-dir>/tasks.md` and `<change-dir>/design.md`, the change's `<base>` (Step 2), which `develop.md` uses for a `fix-` change, and its part of the work. When the spec does not fit the code, it stops and returns a blocker (what it found, the options) instead of redesigning. It commits locally on the feature branch with Conventional Commits (`type(scope): description`, imperative, lowercase) of the change's commit type (below), verifies its work as the standard says (including the CI's commands that can run locally), and returns its verification, any blocker and, for an `update-` or `remove-` change, the commit type it chose. For a light `fix-` change (a `spec.md` with `**Mode:** light` under its title), its verification includes the regression test's failing output before the fix and passing output after it, which the orchestrator records in `<change-dir>/tasks.md` Notes. It does not push. The orchestrator — not the agents — checks off completed tasks in `<change-dir>/tasks.md` and records discoveries in its Notes section.
|
|
70
|
+
|
|
71
|
+
**Commit type.** The change verb sets the Conventional Commit type of the change's commits and of its PR title:
|
|
72
|
+
- `add-` → `feat`, `fix-` → `fix`, `refactor-` → `refactor`.
|
|
73
|
+
- For `update-` and `remove-`, the implementer chooses one Conventional type for the change, uses it and returns it in its result. The orchestrator gives that type to every fix agent (Steps 4 and 5) and uses it in the PR title.
|
|
74
|
+
- When an `update-` or `remove-` change has several implementers, only one chooses: the orchestrator runs one implementer first (the first of a chain, or one of the parallel parts) and gives the type it returns to every other implementer, which starts only once it has the type.
|
|
75
|
+
- Every commit the implementers and fix agents make for the change uses that type, except commits that change only tests (`test`) or only docs (`docs`).
|
|
76
|
+
- When the spec says the change breaks, the type gets `!` after it and the commit a `BREAKING CHANGE:` footer.
|
|
77
|
+
|
|
78
|
+
Each implementer and fix agent prompt states the change's commit type and these rules; the prompt of the implementer that chooses an `update-` or `remove-` type says so instead.
|
|
69
79
|
|
|
70
80
|
### Step 4: Local Review
|
|
71
81
|
|
|
72
|
-
Run up to `review_rounds` review rounds on the local branch, before anything is pushed. With `review_rounds: 0`, skip this step.
|
|
82
|
+
Run up to `review_rounds` review rounds on the local branch, before anything is pushed. With `review_rounds: 0`, skip this step. For a spec with `**Mode:** light` under its title, run up to `min(workflow.review_rounds, 1)` rounds.
|
|
73
83
|
|
|
74
84
|
Each round:
|
|
75
85
|
|
|
76
|
-
1. **Review.** Spawn independent reviewer agents prompted to refute or break the branch diff (`git diff <base>...<branch>` on the round's head,
|
|
86
|
+
1. **Review.** Spawn independent reviewer agents prompted to refute or break the branch diff (`git diff <base>...<branch>` on the round's head, with `<base>` from Step 2): against `spec.md` (each Success Criterion met, nothing outside Scope, nothing it lists as Out of Scope), and for correctness, edge cases and convention violations. A correct diff that does something the spec did not ask for is a finding. For a `fix-` change, the reviewers also check the root cause: the diff fixes the root cause the spec names, not only the symptom, and the regression test would fail without the fix. For a light spec, the reviewers check the diff against its Change section in place of Scope and Out of Scope. Each finding's `file` is a path relative to the repository root, without a leading `./`. The reviewers also check the diff against the user standards: a violation is a finding, whose evidence names the standard file and the rule it breaks.
|
|
77
87
|
2. **Triage findings**, once per round:
|
|
78
88
|
1. Number the round's findings `0..N-1` in the order reported and verify each one. Each gets one verdict: `confirmed` (real), `false_positive` (refuted), `duplicate` (the same problem as an earlier finding of the round, which it names), `nit` (real, cosmetic) or `out_of_scope` (not this change's).
|
|
79
89
|
2. Only `confirmed` findings go to the fix agent. List the `false_positive`, `nit` and `out_of_scope` findings (index, verdict, title) in the Exit report.
|
|
80
|
-
3. **Fix once.** When the round has confirmed findings, spawn one fix agent with them. It commits the fixes locally on the branch and re-runs the CI's commands that can run locally. It does not push.
|
|
81
|
-
4. **Fix check:** spawn one agent that reads the fix commits (`git log` / `git diff` from the round's reviewed head to the new head) and the round's confirmed findings, and answers, per finding, `resolved` or `not resolved` with a one-line reason. It does not look for new problems
|
|
90
|
+
3. **Fix once.** When the round has confirmed findings, spawn one fix agent with them and the change's commit type (Step 3). It commits the fixes locally on the branch, with that type, and re-runs the CI's commands that can run locally. It does not push. For a `fix-` change whose fixes touch the regression test or the fix, it also gets `<home>/standards/develop.md`, `spec.md` and `<base>`, re-runs the base-commit check of `develop.md`'s Verify on the new head, and returns both recorded outputs. For a light `fix-` change whose fixes touch the regression test or the fix, the fix agent re-runs the regression test on the new head instead of the base-commit check, and returns its output.
|
|
91
|
+
4. **Fix check:** spawn one agent that reads the fix commits (`git log` / `git diff` from the round's reviewed head to the new head) and the round's confirmed findings, and answers, per finding, `resolved` or `not resolved` with a one-line reason. For a `fix-` change whose fix commits touch the regression test or the fix, it also gets the fix agent's base-commit outputs, and a finding is `resolved` only when they show the test failing on the base commit for the Root Cause's reason and passing on the new head. For a light `fix-` change, such a finding is `resolved` only when that output shows the regression test passing. It does not look for new problems, except that a finding whose fix breaks a user standard is `not resolved`. Any `not resolved` finding fails the change (Step 6).
|
|
82
92
|
|
|
83
93
|
A round with no confirmed findings ends the step. Otherwise start the next round only while rounds remain under `review_rounds`; the next round reviews the new head.
|
|
84
94
|
|
|
@@ -86,7 +96,7 @@ A round with no confirmed findings ends the step. Otherwise start the next round
|
|
|
86
96
|
|
|
87
97
|
Skipped with `workflow.open_pr: false`.
|
|
88
98
|
|
|
89
|
-
Push the branch once and open the PR with `gh pr create`.
|
|
99
|
+
Push the branch once and open the PR with `gh pr create`. Its title is a Conventional Commit (`type(scope): description`) of the change's commit type (Step 3).
|
|
90
100
|
|
|
91
101
|
- Commit and PR text describe only what the change does — never the process or tooling that produced it.
|
|
92
102
|
- Keep the PR body minimal: one-line subject, bullets only when the change isn't self-evident.
|
|
@@ -96,7 +106,7 @@ Then drive CI on the PR:
|
|
|
96
106
|
1. **Poll the PR checks** on its current head.
|
|
97
107
|
2. **Triage CI.** On a failed run, fetch the log (`gh run view <run-id> --log-failed`, then the full `--log` if that is empty) and quote the real error line before attempting any fix; never diagnose from memory or plausibility. Classify the failure as `code_bug`, `test_failure`, `lint_format`, `typecheck`, `dependency_install`, `flaky_infra`, `base_branch_red` or `unknown`. A failure of this PR (any class but `flaky_infra` and `base_branch_red`) goes to the fix agent; `flaky_infra` and `base_branch_red` follow the not-this-PR path below.
|
|
98
108
|
- **Not this PR's failure** (base branch red or flaky infra): when the base branch is red, port its fix onto the branch if one exists there, otherwise report it; then re-run the failed jobs once (`gh run rerun <run-id> --failed`).
|
|
99
|
-
3. **Fix.** For a failure of this PR, spawn one fix agent with the quoted CI error. It commits the fix on the branch and pushes once.
|
|
109
|
+
3. **Fix.** For a failure of this PR, spawn one fix agent with the quoted CI error and the change's commit type (Step 3). It commits the fix on the branch, with that type, and pushes once.
|
|
100
110
|
|
|
101
111
|
**Caps.** Each CI run of the PR (the first one, every run after a fix push and every re-run) counts as one CI attempt. Drive CI until it is green or `ci_attempts` attempts are used. If CI is still red after attempt `ci_attempts`, the change failed (Step 6).
|
|
102
112
|
|
|
@@ -115,4 +125,4 @@ Then drive CI on the PR:
|
|
|
115
125
|
|
|
116
126
|
## Exit
|
|
117
127
|
|
|
118
|
-
Report per change: branch, PR URL (or the local branch when nothing was pushed), review outcome (review rounds used, the findings not fixed with their verdicts, and the fix-check result per confirmed finding), CI status (CI attempts used; "not run" when nothing was pushed: with `workflow.open_pr: false`, or when the change failed or was blocked before Step 5), whether it was merged or awaits validation (with `workflow.open_pr: false`, the local branch), and any blocker waiting on the user. In series mode, also state where the series stopped and why if it did not complete.
|
|
128
|
+
Report per change: branch, PR URL (or the local branch when nothing was pushed), review outcome (review rounds used, the findings not fixed with their verdicts, and the fix-check result per confirmed finding), CI status (CI attempts used; "not run" when nothing was pushed: with `workflow.open_pr: false`, or when the change failed or was blocked before Step 5), whether it was merged or awaits validation (with `workflow.open_pr: false`, the local branch), and any blocker waiting on the user. In series mode, also state where the series stopped and why if it did not complete. Also name the user standards given to the agents, by file name, or "none".
|
|
@@ -11,28 +11,29 @@ Implement a change as its spec describes it, inline in this session, and show th
|
|
|
11
11
|
## Locate the home
|
|
12
12
|
|
|
13
13
|
Run `theway path` and use the folder it prints as `<home>`: TheWay files are stored in `<home>/<project>/`, where `<project>` is your project directory name. Take `<home>` only from `theway path`, never from a path written in `config.yaml` or elsewhere.
|
|
14
|
-
- If `theway` is not found, tell the user to add the folder theway is installed in (`~/.local/bin` by default) to their `PATH`, or to run `/
|
|
15
|
-
- If it fails with `error: unknown command 'path'`, the installed `theway` is older than these commands: tell the user to run
|
|
16
|
-
- Do not check for files under `<home>` before reading them. If reading `<home>/config.yaml` or a file under `<home>/
|
|
14
|
+
- If `theway` is not found, tell the user to add the folder theway is installed in (`~/.local/bin` by default) to their `PATH`, or to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins`, and stop.
|
|
15
|
+
- If it fails with `error: unknown command 'path'`, the installed `theway` is older than these commands: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop.
|
|
16
|
+
- Do not check for files under `<home>` before reading them. If reading `<home>/config.yaml` or a file under `<home>/standards/` or `<home>/templates/` fails because it does not exist, theway is not set up: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop.
|
|
17
17
|
|
|
18
18
|
## Workflow Steps
|
|
19
19
|
|
|
20
|
-
> Follow the conventions in `<home>/
|
|
20
|
+
> Follow the conventions in `<home>/standards/interaction.md` (exploration, reporting and authority).
|
|
21
21
|
|
|
22
22
|
### Step 1: Load Context
|
|
23
23
|
|
|
24
24
|
Take the change ID from the user's request (e.g. "develop the add-redis-cache change" → `add-redis-cache`); only ask if none is given. Run `theway path <project> <change-id>` and use the folder it prints as `<change-dir>`. Then read these exact paths directly — do not search the filesystem to locate them:
|
|
25
|
-
- `<home>/
|
|
26
|
-
- `<home>/data/standards/develop.md` - How a change is implemented and verified
|
|
25
|
+
- `<home>/standards/develop.md` - How a change is implemented and verified
|
|
27
26
|
- `<change-dir>/spec.md` - Why, what, risks and Success Criteria
|
|
28
27
|
- `<change-dir>/tasks.md` - The work, as numbered tasks
|
|
29
28
|
- `<change-dir>/design.md` - Technical specs (if present)
|
|
30
29
|
- `docs/architecture/coding-standards.md` - Project coding standards (if exists)
|
|
31
30
|
|
|
31
|
+
Then run `theway standards <project> develop` and read every file it prints: these are the user standards. Quote any `theway: warning:` line it writes in your report. If it fails with `error: unknown command 'standards'`, the installed `theway` is older than these commands: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop. When it exits 1 for another reason, quote its `theway:` line in your report and continue with no user standards.
|
|
32
|
+
|
|
32
33
|
### Step 2: Implement and Verify
|
|
33
34
|
|
|
34
|
-
Follow `<home>/
|
|
35
|
+
Follow `<home>/standards/develop.md`: implement the tasks, stop and ask when the spec does not fit, then verify against the spec's Success Criteria. The change files you tick and update are the ones in `<change-dir>`.
|
|
35
36
|
|
|
36
37
|
## Exit
|
|
37
38
|
|
|
38
|
-
Report the tasks done, each Success Criterion with how it was verified, any deviation from the spec and what was decided about it, and anything still open.
|
|
39
|
+
Report the tasks done, each Success Criterion with how it was verified, any deviation from the spec and what was decided about it, and anything still open. Also name the user standards followed, by file name, or "none".
|
|
@@ -13,9 +13,9 @@ You are now in **Document Mode** - creating architecture documentation using tem
|
|
|
13
13
|
## Locate the home
|
|
14
14
|
|
|
15
15
|
Run `theway path` and use the folder it prints as `<home>`: TheWay files are stored in `<home>/<project>/`, where `<project>` is your project directory name. Take `<home>` only from `theway path`, never from a path written in `config.yaml` or elsewhere.
|
|
16
|
-
- If `theway` is not found, tell the user to add the folder theway is installed in (`~/.local/bin` by default) to their `PATH`, or to run `/
|
|
17
|
-
- If it fails with `error: unknown command 'path'`, the installed `theway` is older than these commands: tell the user to run
|
|
18
|
-
- Do not check for files under `<home>` before reading them. If reading `<home>/config.yaml` or a file under `<home>/
|
|
16
|
+
- If `theway` is not found, tell the user to add the folder theway is installed in (`~/.local/bin` by default) to their `PATH`, or to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins`, and stop.
|
|
17
|
+
- If it fails with `error: unknown command 'path'`, the installed `theway` is older than these commands: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop.
|
|
18
|
+
- Do not check for files under `<home>` before reading them. If reading `<home>/config.yaml` or a file under `<home>/standards/` or `<home>/templates/` fails because it does not exist, theway is not set up: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop.
|
|
19
19
|
|
|
20
20
|
## Expected Output
|
|
21
21
|
|
|
@@ -30,17 +30,11 @@ docs/architecture/
|
|
|
30
30
|
|
|
31
31
|
## Workflow
|
|
32
32
|
|
|
33
|
-
> Follow the conventions in `<home>/
|
|
33
|
+
> Follow the conventions in `<home>/standards/interaction.md` (exploration, reporting and authority).
|
|
34
34
|
|
|
35
35
|
### Step 1: Generate Documents from Templates
|
|
36
36
|
|
|
37
|
-
|
|
38
|
-
- `<home>/data/standards/core-principles.md` - Architecture philosophy (only when `standards.core_principles.enabled` is `true`)
|
|
39
|
-
- `<home>/data/standards/sre.md` - SRE operational excellence (only when `standards.sre.enabled` is `true`)
|
|
40
|
-
- `<home>/data/standards/web-development.md` - Web development standards (only when `standards.web_development.enabled` is `true`)
|
|
41
|
-
- `<home>/data/standards/quality.md` - Quality expectations (only when `standards.quality.enabled` is `true`)
|
|
42
|
-
|
|
43
|
-
An opt-in standard is read only when its `enabled` is the boolean `true`; an absent entry or any other value means off.
|
|
37
|
+
Then run `theway standards <project> document` and read every file it prints: these are the shipped opt-in standards that are enabled. Quote any `theway: warning:` line it writes in your report. If it fails with `error: unknown command 'standards'`, the installed `theway` is older than these commands: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop. When it exits 1 for another reason, quote its `theway:` line in your report and continue with no opt-in standards.
|
|
44
38
|
|
|
45
39
|
Then, for each template below, read the template file, follow its frontmatter instructions (required_context, agent_role, workflow_steps, quality_standards, best_practices), and create/update the output file in `docs/architecture/` (overwrite if it already exists). Keep outputs concise — code examples, not verbose explanations.
|
|
46
40
|
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Write a short spec and 1 to 3 tasks for a small change with nothing to decide
|
|
3
|
+
author: Amine
|
|
4
|
+
allowed-tools: Bash(theway:*)
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# TheWay: Engineering Light
|
|
8
|
+
|
|
9
|
+
You are now scaffolding a light Spec analysis using templates: the short spec of a small change with nothing to decide.
|
|
10
|
+
|
|
11
|
+
> **What this command produces.** A short spec someone else can implement without guessing: the problem, the evidence, the change file by file, and 1 to 3 tasks. The code is written later, by `/theway:develop` or `/theway:develop-workflow`, from that spec. A change that needs decisions goes through `/theway:engineering` instead: this command escalates to it and never writes a full spec itself.
|
|
12
|
+
>
|
|
13
|
+
> Write only under `<change-dir>`, the change folder `theway path <project> <change-id>` prints (Step 2). Throwaway probes, yours and the review critic's (Step 5), may also write to a temporary directory created with `mktemp -d`; the change files still go only under `<change-dir>`. Action words in the request ("rename X", "try the fix") describe what the spec should plan, not something to do now.
|
|
14
|
+
>
|
|
15
|
+
> Do **not** suggest entering plan mode — its approval step is a "start coding" trigger that collapses scaffolding into implementation.
|
|
16
|
+
|
|
17
|
+
## Locate the home
|
|
18
|
+
|
|
19
|
+
Run `theway path` and use the folder it prints as `<home>`: TheWay files are stored in `<home>/<project>/`, where `<project>` is your project directory name. Take `<home>` only from `theway path`, never from a path written in `config.yaml` or elsewhere.
|
|
20
|
+
- If `theway` is not found, tell the user to add the folder theway is installed in (`~/.local/bin` by default) to their `PATH`, or to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins`, and stop.
|
|
21
|
+
- If it fails with `error: unknown command 'path'`, the installed `theway` is older than these commands: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop.
|
|
22
|
+
- Do not check for files under `<home>` before reading them. If reading `<home>/config.yaml` or a file under `<home>/standards/` or `<home>/templates/` fails because it does not exist, theway is not set up: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop.
|
|
23
|
+
|
|
24
|
+
## Workflow
|
|
25
|
+
|
|
26
|
+
> Follow the conventions in `<home>/standards/interaction.md` (exploration, reporting and authority).
|
|
27
|
+
|
|
28
|
+
### Step 1: Load Config and Standards
|
|
29
|
+
|
|
30
|
+
Run `theway config <project>` and take the keys below from what it prints: it merges the defaults, the global `config.yaml` and the project's `config.yaml`, and every value it prints is already valid. Quote any `theway: warning:` line it writes in your report. If it fails with `error: unknown command 'config'`, the installed `theway` is older than these commands: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop. When it exits 1 for another reason, quote its `theway:` line and stop.
|
|
31
|
+
|
|
32
|
+
Read these files from `<home>`:
|
|
33
|
+
- `<home>/standards/tamm-framework.md` - TAMM framework
|
|
34
|
+
|
|
35
|
+
Then run `theway standards <project> engineering` and read every file it prints: these are the standards, the shipped opt-in ones that are enabled and yours, and the spec follows them. Quote any `theway: warning:` line it writes in your report. If it fails with `error: unknown command 'standards'`, the installed `theway` is older than these commands: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop. When it exits 1 for another reason, quote its `theway:` line in your report and continue with no standards.
|
|
36
|
+
|
|
37
|
+
Take `engineering.review_rounds` (maximum review rounds in Step 5) and `engineering.models.critic`.
|
|
38
|
+
|
|
39
|
+
### Step 2: Create Change Folder
|
|
40
|
+
|
|
41
|
+
Use naming convention: `add-*`, `update-*`, `refactor-*`, `remove-*`, `fix-*`
|
|
42
|
+
|
|
43
|
+
Example change IDs: `add-user-authentication`, `update-payment-api`, `fix-login-crash`
|
|
44
|
+
|
|
45
|
+
When the request names a change ID, use it.
|
|
46
|
+
|
|
47
|
+
**Validate the ID before writing:** run `theway validate-id <change-id>` only, never with `--series`: a light change is never a series member. It must exit 0 before any change folder is written. On exit 1 with an `invalid change id '<id>': <reason>` line on stderr, fix the ID from that reason and run it again. If it instead fails with `error: unknown command 'validate-id'`, the installed `theway` is stale: do not change the ID; stop and tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins`, then validate again. `validate-id` is the source of truth for the ID format.
|
|
48
|
+
|
|
49
|
+
**Locate the change folder:** once the ID is valid, run `theway path <project> <change-id>` and use the folder it prints as `<change-dir>`. Every file of the change is written there.
|
|
50
|
+
|
|
51
|
+
> The `Write` tool creates parent directories automatically — no need for explicit `mkdir`.
|
|
52
|
+
|
|
53
|
+
### Step 3: Investigate
|
|
54
|
+
|
|
55
|
+
Before drafting, find out what the spec depends on: read the code involved, check how it behaves today, and settle the unknowns. You can clone repositories, run small throwaway scripts, call a service or measure something — whatever answers a specific question the spec has to settle.
|
|
56
|
+
|
|
57
|
+
Keep each investigation to its question. If you notice you are building the change itself to see whether it works, stop: a spec written after the code describes that code instead of the problem, and the blockers and alternatives it should have weighed are never examined. A question you cannot settle this way is a decision: it escalates (below).
|
|
58
|
+
|
|
59
|
+
What you learn goes into the spec's Evidence as findings (question, method, result), not as code or diffs.
|
|
60
|
+
|
|
61
|
+
**For a `fix-` change, reproduce the bug first**, before anything else is settled. Use a throwaway probe in a directory created with `mktemp -d`, or run the project's existing commands and tests without changing the repository. Record the command you ran and the output it printed: they go into the spec's Evidence, quoted. Reasoning about the code is not a reproduction.
|
|
62
|
+
|
|
63
|
+
Then decide the outcome, before any change file is written. Three outcomes stop the command, with no change folder:
|
|
64
|
+
- **Not reproduced:** no attempt reproduced the symptom, including a bug that needs production or is intermittent. Stop and ask the user, listing each attempt (its command and output) and what would help: an environment, a log, exact steps.
|
|
65
|
+
- **Possibly already covered:** an active change ID listed by `theway list <project>` plausibly names the same bug. Stop and ask the user whether that change covers it, naming the ID. Judge from the IDs only: never open other change folders.
|
|
66
|
+
- **Works as intended:** the code and docs show the reported behavior is intended. Report them, and write no change folder.
|
|
67
|
+
|
|
68
|
+
**Escalation check**, for every change, at the end of the investigation and before any change file is written. Escalate when the investigation finds a decision to make, a public contract change, a TAMM risk at Medium or High, or a request for a series. A request that contradicts a standard is a decision to make. A decision is a choice the code, the docs and the request do not settle; a public contract change is a change to a command, CLI, API, config key or file format that others rely on. Escalating writes no change file: report what was found, and tell the user to run `/theway:engineering` with the original request.
|
|
69
|
+
|
|
70
|
+
### Step 4: Generate Documents from Templates
|
|
71
|
+
|
|
72
|
+
For each template below, read the template file, follow its frontmatter instructions (required_context, agent_role, workflow_steps, quality_standards, best_practices), and create the output file in `<change-dir>`:
|
|
73
|
+
|
|
74
|
+
| Template | Output |
|
|
75
|
+
|----------|--------|
|
|
76
|
+
| `<home>/templates/light-spec-template.md` | `spec.md` |
|
|
77
|
+
| `<home>/templates/tasks-template.md` | `tasks.md` |
|
|
78
|
+
|
|
79
|
+
`spec.md` keeps the `**Mode:** light` line directly under its H1 title: the develop commands read it. For a `fix-` change, Problem states the cause with file:line evidence, and Evidence holds the reproduction.
|
|
80
|
+
|
|
81
|
+
`tasks.md` departs from `tasks-template.md` in one way: it has no `## Phase` headings. It has 1 to 3 numbered tasks directly under the H1, then the template's Notes section. The template's phase rules do not apply: the `quality_standards` entry "Tasks are organized by logical implementation phases", `workflow_steps` 1-3, and the `best_practices` entry "Ensure every spec phase has corresponding tasks". In a `fix-` change, task 1 writes the regression test; re-running the reproduction is not a task, as it is part of Verify.
|
|
82
|
+
|
|
83
|
+
A light change has no `design.md`.
|
|
84
|
+
|
|
85
|
+
### Step 5: Review
|
|
86
|
+
|
|
87
|
+
Run up to `min(engineering.review_rounds, 1)` review rounds with one grounding critic. With `review_rounds: 0`, skip this step. An open question would have escalated in Step 3, so there is none to wait for.
|
|
88
|
+
|
|
89
|
+
1. **Review.** Spawn one critic agent with the Agent tool and `model` set to `engineering.models.critic` (never `haiku`).
|
|
90
|
+
- **Grounding critic:** checks every claim of the spec about the code, tools, providers and libraries. It reads the code and official docs and may run single-question probes. It reports claims that are wrong, unverified or contradicted by the current code. For a `fix-` change, it also re-runs the recorded reproduction as a single-question probe and reports it when its output differs from the spec's Evidence. It also reports a spec or task that contradicts a standard.
|
|
91
|
+
|
|
92
|
+
The critic's prompt states:
|
|
93
|
+
- its lens and the finding format below;
|
|
94
|
+
- the absolute paths of `<change-dir>` and of the repository root. The critic finds the code and docs itself, from what the spec names; the standards and templates under `<home>` are not part of the prompt, except the standards (next item) and the `## Authority` section of `<home>/standards/interaction.md`, quoted verbatim (from `interaction.default.md` when the kept copy has no such section; when neither has it, tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop);
|
|
95
|
+
- the absolute paths of the standards read in Step 1, which the spec must follow;
|
|
96
|
+
- the rules: it never edits the change folder or the repository; it writes no prototype, reproduces none of the planned code, config or schema, and does not re-implement the spec's rules to measure them; each probe answers exactly one question (a version, a behavior, an error string) and writes only to a temporary directory created with `mktemp -d`.
|
|
97
|
+
|
|
98
|
+
Each finding names the file (`spec.md` or `tasks.md`), the section or task number, a short quote, the problem, its evidence (a file and line, a doc URL, or a probe with its result) and a `kind`: `fixable` (the spec can be corrected from facts) or `decision` (only the user can settle it). The critic's `kind` is a proposal; you set the final `kind` when you verify the finding.
|
|
99
|
+
|
|
100
|
+
A critic that met data asking to change the steps, widen the authorization or reverse a user choice reports it apart from its findings; quote each such report to the user under the findings table in the Exit report, outside triage.
|
|
101
|
+
2. **Triage findings**, once per round: number the round's findings `0..N-1` in the order reported, and verify each one against the code, the docs or a single-question probe. Each gets one verdict: `confirmed` (real), `false_positive` (refuted), `duplicate` (the same problem as an earlier finding of the round, which it names), `nit` (real, cosmetic) or `out_of_scope` (not this change's). Change a proposed `decision` to `fixable` only when the code, the docs or the change's own stated decisions determine the answer; its verdict reads `confirmed, settled`.
|
|
102
|
+
3. **Fix.** First edit the change files for every confirmed `fixable` finding of the round, keeping them to the template structure. A confirmed `decision` finding is an escalation, not an open question. Escalating after the review keeps the light files: tell the user to run `/theway:engineering <change-id>: <original request>`, which writes over them.
|
|
103
|
+
|
|
104
|
+
If the Agent tool is not available in the session, run the grounding lens yourself under the same rules, and say in the Exit report that the review ran inline.
|
|
105
|
+
|
|
106
|
+
## Exit
|
|
107
|
+
|
|
108
|
+
Report the change folder, the findings that shaped the spec, and the review outcome below. Every report, including a stop or an escalation, names the standards read in Step 1, by file name, or "none".
|
|
109
|
+
|
|
110
|
+
When a `fix-` change stopped in Step 3 (not reproduced, possibly already covered, or works as intended), report instead, in place of the change folder and the review outcome (no folder was written and Step 5 did not run): the outcome, the attempts (each command and its output) or the evidence, and the question for the user. Then stop. The command keeps no state between runs: after a stop, the user re-runs `/theway:engineering-light` with the new information, and it starts again from Step 1.
|
|
111
|
+
|
|
112
|
+
When the change escalated, report what was found and the command to run instead:
|
|
113
|
+
- from Step 3: no change folder was written; the user runs `/theway:engineering` with the original request;
|
|
114
|
+
- from Step 5: the confirmed `decision` findings, and `/theway:engineering <change-id>: <original request>`, which writes over the light files.
|
|
115
|
+
|
|
116
|
+
The review outcome:
|
|
117
|
+
- how it ran: the rounds used, off (`review_rounds: 0`), or inline;
|
|
118
|
+
- every finding of every round in one Markdown table with the columns `#`, `Finding`, `Verdict` and `Fix`, one row per finding:
|
|
119
|
+
- `#` is the round and the triage index, as `R<round>-<index>`, for example `R1-0`;
|
|
120
|
+
- `Finding` is one line saying what is wrong;
|
|
121
|
+
- `Verdict` is the triage verdict, or `confirmed, settled` for a proposed `decision` you settled as `fixable`;
|
|
122
|
+
- `Fix` says how the change files changed for a confirmed `fixable` finding, reads `escalated` for a confirmed `decision`, names the earlier `#` for a `duplicate`, and gives the one-line reason for the other verdicts;
|
|
123
|
+
- under the table, each `confirmed, settled` finding again, with the choice made, so the user can overturn it.
|
|
@@ -17,45 +17,42 @@ You are now scaffolding a Spec analysis using templates.
|
|
|
17
17
|
## Locate the home
|
|
18
18
|
|
|
19
19
|
Run `theway path` and use the folder it prints as `<home>`: TheWay files are stored in `<home>/<project>/`, where `<project>` is your project directory name. Take `<home>` only from `theway path`, never from a path written in `config.yaml` or elsewhere.
|
|
20
|
-
- If `theway` is not found, tell the user to add the folder theway is installed in (`~/.local/bin` by default) to their `PATH`, or to run `/
|
|
21
|
-
- If it fails with `error: unknown command 'path'`, the installed `theway` is older than these commands: tell the user to run
|
|
22
|
-
- Do not check for files under `<home>` before reading them. If reading `<home>/config.yaml` or a file under `<home>/
|
|
20
|
+
- If `theway` is not found, tell the user to add the folder theway is installed in (`~/.local/bin` by default) to their `PATH`, or to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins`, and stop.
|
|
21
|
+
- If it fails with `error: unknown command 'path'`, the installed `theway` is older than these commands: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop.
|
|
22
|
+
- Do not check for files under `<home>` before reading them. If reading `<home>/config.yaml` or a file under `<home>/standards/` or `<home>/templates/` fails because it does not exist, theway is not set up: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop.
|
|
23
23
|
|
|
24
24
|
## Workflow
|
|
25
25
|
|
|
26
|
-
> Follow the conventions in `<home>/
|
|
26
|
+
> Follow the conventions in `<home>/standards/interaction.md` (exploration, reporting and authority).
|
|
27
27
|
|
|
28
28
|
### Step 1: Load Config and Standards
|
|
29
29
|
|
|
30
|
-
|
|
31
|
-
- `<home>/config.yaml` - Global config
|
|
32
|
-
- `<home>/data/standards/tamm-framework.md` - TAMM framework
|
|
33
|
-
- `<home>/data/standards/core-principles.md` - Architecture philosophy (only when `standards.core_principles.enabled` is `true`)
|
|
34
|
-
- `<home>/data/standards/sre.md` - SRE operational excellence (only when `standards.sre.enabled` is `true`)
|
|
35
|
-
- `<home>/data/standards/web-development.md` - Web development standards (only when `standards.web_development.enabled` is `true`)
|
|
36
|
-
- `<home>/data/standards/quality.md` - Quality expectations (only when `standards.quality.enabled` is `true`)
|
|
30
|
+
Run `theway config <project>` and take the keys below from what it prints: it merges the defaults, the global `config.yaml` and the project's `config.yaml`, and every value it prints is already valid. Quote any `theway: warning:` line it writes in your report. If it fails with `error: unknown command 'config'`, the installed `theway` is older than these commands: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop. When it exits 1 for another reason, quote its `theway:` line and stop.
|
|
37
31
|
|
|
38
|
-
|
|
32
|
+
Read these files from `<home>`:
|
|
33
|
+
- `<home>/standards/tamm-framework.md` - TAMM framework
|
|
39
34
|
|
|
40
|
-
|
|
35
|
+
Then run `theway standards <project> engineering` and read every file it prints: these are the standards, the shipped opt-in ones that are enabled and yours, and the spec follows them. Quote any `theway: warning:` line it writes in your report. If it fails with `error: unknown command 'standards'`, the installed `theway` is older than these commands: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop. When it exits 1 for another reason, quote its `theway:` line in your report and continue with no standards.
|
|
41
36
|
|
|
42
|
-
|
|
37
|
+
Take `engineering.review_rounds` (maximum review rounds in Step 6) and `engineering.models.critic`.
|
|
43
38
|
|
|
44
39
|
### Step 2: Create Change Folder
|
|
45
40
|
|
|
46
|
-
Use naming convention: `add-*`, `update-*`, `refactor-*`, `remove-*`
|
|
41
|
+
Use naming convention: `add-*`, `update-*`, `refactor-*`, `remove-*`, `fix-*`
|
|
42
|
+
|
|
43
|
+
Example change IDs: `add-user-authentication`, `update-payment-api`, `fix-login-crash`
|
|
47
44
|
|
|
48
|
-
|
|
45
|
+
A `fix-` change fixes a bug: Steps 3, 4 and 6 have rules of their own for it.
|
|
49
46
|
|
|
50
47
|
**Series naming**
|
|
51
48
|
|
|
52
49
|
- **Trigger:** the request is a series when the user asks for a series, for multiple sequential changes, or to "split into N changes", or when the argument passed already ends in `-NN`. In series mode the argument given to `/theway:engineering` is the `<series-id>`, not a change ID; if it already ends in `-NN`, strip that ordinal to get the `<series-id>` (never append a second one).
|
|
53
|
-
- **Pattern:** every member is `<series-id>-NN` — a shared verb-prefixed kebab-case `<series-id>` (same `add-`/`update-`/`refactor-`/`remove-` rule) plus a zero-padded two-digit ordinal starting at `01`, assigned in dependency order.
|
|
50
|
+
- **Pattern:** every member is `<series-id>-NN` — a shared verb-prefixed kebab-case `<series-id>` (same `add-`/`update-`/`refactor-`/`remove-`/`fix-` rule) plus a zero-padded two-digit ordinal starting at `01`, assigned in dependency order.
|
|
54
51
|
- **Continuation:** before assigning ordinals, run `theway path <project>` and use the folder it prints as `<project-dir>`, then `Glob` `<project-dir>/changes/<series-id>-[0-9][0-9]` and `<project-dir>/changes/archive/*-<series-id>-[0-9][0-9]` (archived folders are named `YYYY-MM-DD-<change-id>`; match only the exact `<series-id>`, not sibling series that merely end with it). Continue from the next free ordinal — never restart at `01`, never rename or renumber existing folders.
|
|
55
52
|
- **Forbidden:** topic-word suffixes (`add-user-auth-login`), letter suffixes in place of the ordinal (`-a`, `-b`; a standalone ID may still end in a one-letter word that is part of its name, e.g. `add-vitamin-c`, so a member of a series is always validated with `--series`), unpadded numbers (`-1`), mixing standalone IDs and series IDs within one series, and putting an ordinal on a single (non-series) change.
|
|
56
53
|
- **Example:** `add-user-auth-01`, `add-user-auth-02`, `add-user-auth-03`.
|
|
57
54
|
|
|
58
|
-
**Validate every ID before writing:** run exactly one form per ID — a standalone change: `theway validate-id <change-id>`; a series member: `theway validate-id <change-id> --series` only (never the form without `--series`, which rejects every `-NN` ID). It must exit 0 before any change folder is written. On exit 1 with an `invalid change id '<id>': <reason>` line on stderr, fix the ID from that reason and run it again. If it instead fails with `error: unknown command 'validate-id'`, the installed `theway` is stale: do not change the ID; stop and tell the user to run `/
|
|
55
|
+
**Validate every ID before writing:** run exactly one form per ID — a standalone change: `theway validate-id <change-id>`; a series member: `theway validate-id <change-id> --series` only (never the form without `--series`, which rejects every `-NN` ID). It must exit 0 before any change folder is written. On exit 1 with an `invalid change id '<id>': <reason>` line on stderr, fix the ID from that reason and run it again. If it instead fails with `error: unknown command 'validate-id'`, the installed `theway` is stale: do not change the ID; stop and tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins`, then validate again. `validate-id` is the source of truth for the ID format.
|
|
59
56
|
|
|
60
57
|
**Locate the change folder:** once an ID is valid, run `theway path <project> <change-id>` and use the folder it prints as `<change-dir>` for that change (one per member in a series). Every file of the change is written there.
|
|
61
58
|
|
|
@@ -65,19 +62,32 @@ Example change IDs: `add-user-authentication`, `update-payment-api`
|
|
|
65
62
|
|
|
66
63
|
Before drafting, find out what the spec depends on: read the code involved, check how it behaves today, and settle the unknowns. You can clone repositories, run small throwaway scripts, call a service or measure something — whatever answers a specific question the spec has to settle.
|
|
67
64
|
|
|
65
|
+
A request that contradicts a standard is an open question for the user.
|
|
66
|
+
|
|
68
67
|
Keep each investigation to its question. If you notice you are building the change itself to see whether it works, stop: a spec written after the code describes that code instead of the problem, and the blockers and alternatives it should have weighed are never examined. Turn what you were trying to learn into a question for the user, or record it in the spec as an open point.
|
|
69
68
|
|
|
70
69
|
What you learn goes into the spec as findings (question, method, result), not as code or diffs.
|
|
71
70
|
|
|
71
|
+
**For a `fix-` change, reproduce the bug first**, before anything else is settled. Use a throwaway probe in a directory created with `mktemp -d`, or run the project's existing commands and tests without changing the repository. Record the command you ran and the output it printed: they go into the spec's Reproduction, quoted. Reasoning about the code is not a reproduction.
|
|
72
|
+
|
|
73
|
+
Then decide the outcome, before any change file is written. Three outcomes stop the command, with no change folder:
|
|
74
|
+
- **Not reproduced:** no attempt reproduced the symptom, including a bug that needs production or is intermittent. Stop and ask the user, listing each attempt (its command and output) and what would help: an environment, a log, exact steps.
|
|
75
|
+
- **Possibly already covered:** an active change ID listed by `theway list <project>` plausibly names the same bug. The members of the series this run continues (Step 2) do not count: they share its name by construction. The change ID this run picked in Step 2 does not count either: its folder is written over. Stop and ask the user whether that change covers it, naming the ID. Judge from the IDs only: never open other change folders.
|
|
76
|
+
- **Works as intended:** the code and docs show the reported behavior is intended. Report them, and write no change folder.
|
|
77
|
+
|
|
78
|
+
Otherwise the bug is reproduced: continue to Step 4.
|
|
79
|
+
|
|
72
80
|
### Step 4: Generate Documents from Templates
|
|
73
81
|
|
|
74
82
|
For each template below, read the template file, follow its frontmatter instructions (required_context, agent_role, workflow_steps, quality_standards, best_practices), and create the output file in `<change-dir>`:
|
|
75
83
|
|
|
76
84
|
| Template | Output |
|
|
77
85
|
|----------|--------|
|
|
78
|
-
| `<home>/templates/spec-template.md` | `spec.md` |
|
|
86
|
+
| `<home>/templates/spec-template.md`, or `<home>/templates/fix-spec-template.md` for a `fix-` ID | `spec.md` |
|
|
79
87
|
| `<home>/templates/tasks-template.md` | `tasks.md` |
|
|
80
88
|
|
|
89
|
+
A `fix-` ID uses `fix-spec-template.md`; every other verb uses `spec-template.md`. In a `fix-` change, task 1 writes the regression test; re-running the reproduction is not a task, as it is part of Verify.
|
|
90
|
+
|
|
81
91
|
For a series, each member's `spec.md` carries one line directly under its H1 title:
|
|
82
92
|
`**Series:** <series-id> — NN of TOTAL, depends on <series-id>-(NN-1)` — the `01` member states no dependency.
|
|
83
93
|
|
|
@@ -97,7 +107,7 @@ Run up to `review_rounds` review rounds. In a series, each round covers every me
|
|
|
97
107
|
Each round:
|
|
98
108
|
|
|
99
109
|
1. **Review.** Spawn two critic agents in parallel, in a single message, with the Agent tool and `model` set to `engineering.models.critic` (never `haiku`). Neither sees the other's findings.
|
|
100
|
-
- **Grounding critic:** checks every claim of the spec about the code, tools, providers and libraries. It reads the code and official docs and may run single-question probes. It reports claims that are wrong, unverified or contradicted by the current code.
|
|
110
|
+
- **Grounding critic:** checks every claim of the spec about the code, tools, providers and libraries. It reads the code and official docs and may run single-question probes. It reports claims that are wrong, unverified or contradicted by the current code. For a `fix-` change, it also re-runs the recorded reproduction as a single-question probe and reports it when its output differs from the spec's.
|
|
101
111
|
- **Implementability critic:** checks whether a cold-start implementer could carry out the change without guessing. It reports:
|
|
102
112
|
- choices left open ("probe X then decide", "A or B", "if needed");
|
|
103
113
|
- Success Criteria that cannot be checked, or whose check passes whatever the code does;
|
|
@@ -105,11 +115,13 @@ Each round:
|
|
|
105
115
|
- tasks outside the Scope or listed as Out of Scope;
|
|
106
116
|
- tasks that cannot be done as written (a missing file, a command that does not exist, an environment the task assumes);
|
|
107
117
|
- contradictions between the spec and its tasks, or with the existing command, config or doc text the change touches;
|
|
118
|
+
- a spec or task that contradicts a standard;
|
|
108
119
|
- in a series, gaps and overlaps between members.
|
|
109
120
|
|
|
110
121
|
Each critic's prompt states:
|
|
111
122
|
- its lens and the finding format below;
|
|
112
|
-
- the absolute paths of `<change-dir>` (every member's folder in a series) and of the repository root. The critic finds the code and docs itself, from what the spec names; the standards and templates under `<home>` are not part of the prompt, except the `## Authority` section of `<home>/
|
|
123
|
+
- the absolute paths of `<change-dir>` (every member's folder in a series) and of the repository root. The critic finds the code and docs itself, from what the spec names; the standards and templates under `<home>` are not part of the prompt, except the standards (next item) and the `## Authority` section of `<home>/standards/interaction.md`, quoted verbatim (from `interaction.default.md` when the kept copy has no such section; when neither has it, tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop);
|
|
124
|
+
- the absolute paths of the standards read in Step 1, which the spec must follow;
|
|
113
125
|
- the rules: it never edits the change folder or the repository; it writes no prototype, reproduces none of the planned code, config or schema, and does not re-implement the spec's rules to measure them; each probe answers exactly one question (a version, a behavior, an error string) and writes only to a temporary directory created with `mktemp -d`.
|
|
114
126
|
|
|
115
127
|
Each finding names the file (`spec.md`, `tasks.md` or `design.md`, plus the change ID in a series), the section or task number, a short quote, the problem, its evidence (a file and line, a doc URL, or a probe with its result) and a `kind`: `fixable` (the spec can be corrected from facts) or `decision` (only the user can settle it). The critic's `kind` is a proposal; you set the final `kind` when you verify the finding.
|
|
@@ -124,7 +136,9 @@ If the Agent tool is not available in the session, run both lenses yourself, one
|
|
|
124
136
|
|
|
125
137
|
## Exit
|
|
126
138
|
|
|
127
|
-
Report the change folder, the findings that shaped the spec, the review outcome below, and any question still open. A confirmed `decision` finding of Step 6 is an open question. If a question is open, stop after this report; the spec is not ready until it is answered.
|
|
139
|
+
Report the change folder, the findings that shaped the spec, the review outcome below, and any question still open. A confirmed `decision` finding of Step 6 is an open question. If a question is open, stop after this report; the spec is not ready until it is answered. Every report, including a stop or an escalation, names the standards read in Step 1, by file name, or "none".
|
|
140
|
+
|
|
141
|
+
When a `fix-` change stopped in Step 3 (not reproduced, possibly already covered, or works as intended), report instead, in place of the change folder and the review outcome (no folder was written and Step 6 did not run): the outcome, the attempts (each command and its output) or the evidence, and the question for the user. Then stop. The command keeps no state between runs: after a stop, the user re-runs `/theway:engineering` with the new information, and it starts again from Step 1.
|
|
128
142
|
|
|
129
143
|
The review outcome:
|
|
130
144
|
- how it ran: the rounds used, off (`review_rounds: 0`), not run because a question was already open, or inline;
|
package/plugin/commands/list.md
CHANGED
|
@@ -9,9 +9,9 @@ allowed-tools: Bash(theway:*)
|
|
|
9
9
|
## Locate the home
|
|
10
10
|
|
|
11
11
|
Run `theway path` and use the folder it prints as `<home>`: TheWay files are stored in `<home>/<project>/`, where `<project>` is your project directory name. Take `<home>` only from `theway path`, never from a path written in `config.yaml` or elsewhere.
|
|
12
|
-
- If `theway` is not found, tell the user to add the folder theway is installed in (`~/.local/bin` by default) to their `PATH`, or to run `/
|
|
13
|
-
- If it fails with `error: unknown command 'path'`, the installed `theway` is older than these commands: tell the user to run
|
|
14
|
-
- Do not check for files under `<home>` before reading them. If reading `<home>/config.yaml` or a file under `<home>/
|
|
12
|
+
- If `theway` is not found, tell the user to add the folder theway is installed in (`~/.local/bin` by default) to their `PATH`, or to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins`, and stop.
|
|
13
|
+
- If it fails with `error: unknown command 'path'`, the installed `theway` is older than these commands: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop.
|
|
14
|
+
- Do not check for files under `<home>` before reading them. If reading `<home>/config.yaml` or a file under `<home>/standards/` or `<home>/templates/` fails because it does not exist, theway is not set up: tell the user to run `npx --yes @pixelfactoryio/theway@latest install` then `/reload-plugins` and stop.
|
|
15
15
|
|
|
16
16
|
## List
|
|
17
17
|
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# theway configuration
|
|
2
|
+
# A project can override any key in <home>/<project>/config.yaml; theway config <project> prints the result.
|
|
3
|
+
|
|
4
|
+
# Standards: standards.<key>.enabled switches any standard, key = file stem with - as _ (shipped opt-in ones default false, your own standards true)
|
|
5
|
+
standards:
|
|
6
|
+
# Architecture philosophy (simplicity, security, pragmatic technology)
|
|
7
|
+
core_principles:
|
|
8
|
+
enabled: false
|
|
9
|
+
# SRE operational excellence (reliability, observability, automation)
|
|
10
|
+
sre:
|
|
11
|
+
enabled: false
|
|
12
|
+
# Frontend, API and backend standards with web performance targets
|
|
13
|
+
web_development:
|
|
14
|
+
enabled: false
|
|
15
|
+
# Testing, deployment, monitoring and security expectations
|
|
16
|
+
quality:
|
|
17
|
+
enabled: false
|
|
18
|
+
|
|
19
|
+
# Engineering - spec review for /theway:engineering (absent or invalid key means the default)
|
|
20
|
+
engineering:
|
|
21
|
+
# Maximum review rounds per scaffold; 0 skips the review
|
|
22
|
+
review_rounds: 1
|
|
23
|
+
# Model of the two critic agents: opus or sonnet (absent or invalid means the default)
|
|
24
|
+
# Lower cost: sonnet
|
|
25
|
+
models:
|
|
26
|
+
critic: opus
|
|
27
|
+
|
|
28
|
+
# Develop Workflow - caps for /theway:develop-workflow (absent or invalid key means the default)
|
|
29
|
+
workflow:
|
|
30
|
+
# Review rounds per change; 0 skips review and the fix check
|
|
31
|
+
review_rounds: 1
|
|
32
|
+
# CI attempts per change to reach green, re-runs included
|
|
33
|
+
ci_attempts: 2
|
|
34
|
+
# Push the branch, open the PR and drive CI after the local review; false stops at the reviewed local branch
|
|
35
|
+
open_pr: true
|
|
36
|
+
# Model per agent role: opus or sonnet (absent or invalid means the default)
|
|
37
|
+
# Lower cost: implementer, fix and ci on sonnet, reviewer on opus
|
|
38
|
+
models:
|
|
39
|
+
implementer: opus
|
|
40
|
+
# Adversarial reviewers and the fix check
|
|
41
|
+
reviewer: opus
|
|
42
|
+
fix: opus
|
|
43
|
+
# CI polling and log fetching
|
|
44
|
+
ci: sonnet
|