@turri-dev/cli 0.0.0-stage → 0.1.2-next.48dacfc
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/.pi/themes/turri-dark.json +80 -0
- package/.pi/themes/turri-light.json +82 -0
- package/LICENSE +21 -0
- package/README.md +272 -2
- package/assets/jellyfish/dark-00.png +0 -0
- package/assets/jellyfish/dark-01.png +0 -0
- package/assets/jellyfish/dark-02.png +0 -0
- package/assets/jellyfish/dark-03.png +0 -0
- package/assets/jellyfish/dark-04.png +0 -0
- package/assets/jellyfish/dark-05.png +0 -0
- package/assets/jellyfish/dark-06.png +0 -0
- package/assets/jellyfish/dark-07.png +0 -0
- package/assets/jellyfish/dark-08.png +0 -0
- package/assets/jellyfish/dark-09.png +0 -0
- package/assets/jellyfish/dark-10.png +0 -0
- package/assets/jellyfish/dark-11.png +0 -0
- package/assets/jellyfish/dark-12.png +0 -0
- package/assets/jellyfish/dark-13.png +0 -0
- package/assets/jellyfish/dark-14.png +0 -0
- package/assets/jellyfish/fallback.txt +252 -0
- package/assets/jellyfish/light-00.png +0 -0
- package/assets/jellyfish/light-01.png +0 -0
- package/assets/jellyfish/light-02.png +0 -0
- package/assets/jellyfish/light-03.png +0 -0
- package/assets/jellyfish/light-04.png +0 -0
- package/assets/jellyfish/light-05.png +0 -0
- package/assets/jellyfish/light-06.png +0 -0
- package/assets/jellyfish/light-07.png +0 -0
- package/assets/jellyfish/light-08.png +0 -0
- package/assets/jellyfish/light-09.png +0 -0
- package/assets/jellyfish/light-10.png +0 -0
- package/assets/jellyfish/light-11.png +0 -0
- package/assets/jellyfish/light-12.png +0 -0
- package/assets/jellyfish/light-13.png +0 -0
- package/assets/jellyfish/light-14.png +0 -0
- package/bin/turri.mjs +29 -0
- package/dist/ask.js +149 -0
- package/dist/brand.js +50 -0
- package/dist/btw.js +174 -0
- package/dist/chat-models.js +37 -0
- package/dist/chat-skills.js +18 -0
- package/dist/cli.js +178 -0
- package/dist/config-command.js +197 -0
- package/dist/config-edit.js +367 -0
- package/dist/config.js +489 -0
- package/dist/conform-cli.js +29 -0
- package/dist/cultivate-cli.js +110 -0
- package/dist/drift-cli.js +25 -0
- package/dist/environment.js +70 -0
- package/dist/extension.js +2372 -0
- package/dist/genome.js +301 -0
- package/dist/graph.js +246 -0
- package/dist/identity.js +35 -0
- package/dist/init-config.js +511 -0
- package/dist/judge.js +62 -0
- package/dist/lineage-cli.js +13 -0
- package/dist/loop-cli.js +132 -0
- package/dist/loop-tools.js +225 -0
- package/dist/mature-tools.js +193 -0
- package/dist/model-check.js +117 -0
- package/dist/module-report.js +9 -0
- package/dist/pi-launch.js +31 -0
- package/dist/pi.js +813 -0
- package/dist/plain/check.js +76 -0
- package/dist/plain/concepts.js +213 -0
- package/dist/plain/errors.js +43 -0
- package/dist/plain/files.js +57 -0
- package/dist/plain/highlight.js +195 -0
- package/dist/plain/index.js +15 -0
- package/dist/plain/liquid.js +129 -0
- package/dist/plain/markdown.js +208 -0
- package/dist/plain/parser.js +752 -0
- package/dist/plain/plain.tmLanguage.json +124 -0
- package/dist/plain/spec.js +291 -0
- package/dist/plain/stdlib.js +44 -0
- package/dist/question-dialog.js +125 -0
- package/dist/questioning.js +109 -0
- package/dist/quiet.js +125 -0
- package/dist/regenerate/activity.js +187 -0
- package/dist/regenerate/agent-env.js +190 -0
- package/dist/regenerate/agent-shell.js +114 -0
- package/dist/regenerate/arbiter.js +133 -0
- package/dist/regenerate/audit.js +203 -0
- package/dist/regenerate/cases.js +83 -0
- package/dist/regenerate/change-view.js +102 -0
- package/dist/regenerate/choose-conformance.js +117 -0
- package/dist/regenerate/chunk-plan.js +625 -0
- package/dist/regenerate/codebase.js +75 -0
- package/dist/regenerate/command-check.js +312 -0
- package/dist/regenerate/compaction.js +20 -0
- package/dist/regenerate/confine.js +310 -0
- package/dist/regenerate/conform.js +133 -0
- package/dist/regenerate/conformance-agents.js +955 -0
- package/dist/regenerate/conformance.js +936 -0
- package/dist/regenerate/conversation-writes.js +100 -0
- package/dist/regenerate/credentials.js +88 -0
- package/dist/regenerate/debug-log.js +228 -0
- package/dist/regenerate/debugger.js +90 -0
- package/dist/regenerate/delivery.js +19 -0
- package/dist/regenerate/diagnose-job.js +40 -0
- package/dist/regenerate/diagnose.js +81 -0
- package/dist/regenerate/diff-view.js +240 -0
- package/dist/regenerate/drift.js +194 -0
- package/dist/regenerate/engine.js +118 -0
- package/dist/regenerate/environment-error.js +220 -0
- package/dist/regenerate/job-log.js +102 -0
- package/dist/regenerate/job-panel.js +336 -0
- package/dist/regenerate/jobs-tree.js +300 -0
- package/dist/regenerate/jobs.js +427 -0
- package/dist/regenerate/lanes.js +32 -0
- package/dist/regenerate/lineage.js +384 -0
- package/dist/regenerate/loop.js +1435 -0
- package/dist/regenerate/masking.js +95 -0
- package/dist/regenerate/notes.js +397 -0
- package/dist/regenerate/os-sandbox.js +243 -0
- package/dist/regenerate/paths.js +165 -0
- package/dist/regenerate/plain-palette.js +83 -0
- package/dist/regenerate/prompt.js +704 -0
- package/dist/regenerate/records.js +294 -0
- package/dist/regenerate/regenerate.js +598 -0
- package/dist/regenerate/regression.js +181 -0
- package/dist/regenerate/release.js +262 -0
- package/dist/regenerate/requires.js +241 -0
- package/dist/regenerate/resources.js +164 -0
- package/dist/regenerate/self-check.js +111 -0
- package/dist/regenerate/services.js +155 -0
- package/dist/regenerate/shell.js +320 -0
- package/dist/regenerate/side-panel.js +278 -0
- package/dist/regenerate/spec-map-view.js +574 -0
- package/dist/regenerate/spec-map.js +561 -0
- package/dist/regenerate/spec-steps.js +527 -0
- package/dist/regenerate/state.js +10 -0
- package/dist/regenerate/steer.js +91 -0
- package/dist/regenerate/steering.js +119 -0
- package/dist/regenerate/stop-report.js +161 -0
- package/dist/regenerate/submit-work.js +71 -0
- package/dist/regenerate/test-kinds.js +124 -0
- package/dist/regenerate/test-scripts.js +695 -0
- package/dist/regenerate/testing.js +406 -0
- package/dist/regenerate/transcript-view.js +1 -0
- package/dist/regenerate/unit-gate.js +20 -0
- package/dist/regenerate/unit-review.js +347 -0
- package/dist/regenerate/web.js +256 -0
- package/dist/regenerate/workspace.js +99 -0
- package/dist/regenerate-cli.js +68 -0
- package/dist/release-agent.js +114 -0
- package/dist/release-cli.js +131 -0
- package/dist/release-tools.js +148 -0
- package/dist/review/live.js +165 -0
- package/dist/rules.js +47 -0
- package/dist/self-invocation.js +110 -0
- package/dist/setup.js +245 -0
- package/dist/skill-progress.js +78 -0
- package/dist/skill.js +149 -0
- package/dist/skills.js +74 -0
- package/dist/spec-diff-cli.js +37 -0
- package/dist/spec-tools.js +155 -0
- package/dist/stack.js +158 -0
- package/dist/stacks.js +97 -0
- package/dist/stdlib.js +100 -0
- package/dist/terminal-images.js +46 -0
- package/dist/tools.js +242 -0
- package/dist/validate-cli.js +52 -0
- package/docs/README.md +58 -0
- package/docs/authoring-plain.md +245 -0
- package/docs/config.md +353 -0
- package/docs/deploy.md +109 -0
- package/docs/development.md +88 -0
- package/docs/headless.md +148 -0
- package/docs/images/how-turri-works.svg +50 -0
- package/docs/images/turri-banner.png +0 -0
- package/docs/installation.md +119 -0
- package/docs/parser.md +108 -0
- package/docs/regenerating.md +1116 -0
- package/docs/sandbox.md +233 -0
- package/docs/skills-and-gates.md +254 -0
- package/docs/theming.md +76 -0
- package/docs/using.md +454 -0
- package/genome/rules/bullet-continuation.md +69 -0
- package/genome/rules/concise-specs-examples.md +431 -0
- package/genome/rules/concise-specs-integration-examples.md +270 -0
- package/genome/rules/concise-specs.md +80 -0
- package/genome/rules/definitions.md +107 -0
- package/genome/rules/examples/integration-embedded-testing/run_conformance_tests_java.sh +163 -0
- package/genome/rules/examples/integration-embedded-testing/run_unittests_java.sh +51 -0
- package/genome/rules/exported-concepts.md +39 -0
- package/genome/rules/func-specs.md +129 -0
- package/genome/rules/impl-reqs.md +68 -0
- package/genome/rules/import-modules.md +48 -0
- package/genome/rules/integration-embedded-testing.md +276 -0
- package/genome/rules/integration-embedded.md +171 -0
- package/genome/rules/integration-standalone.md +135 -0
- package/genome/rules/integrations.md +137 -0
- package/genome/rules/linked-resources.md +69 -0
- package/genome/rules/module-structure.md +105 -0
- package/genome/rules/project-model.md +88 -0
- package/genome/rules/required-concepts.md +44 -0
- package/genome/rules/requires-modules.md +80 -0
- package/genome/rules/stdlib.md +73 -0
- package/genome/rules/test-reqs.md +57 -0
- package/genome/skills/add-acceptance-test/SKILL.md +100 -0
- package/genome/skills/add-concept/SKILL.md +71 -0
- package/genome/skills/add-functional-spec/SKILL.md +84 -0
- package/genome/skills/add-functional-specs/SKILL.md +118 -0
- package/genome/skills/add-implementation-requirement/SKILL.md +86 -0
- package/genome/skills/add-resource/SKILL.md +105 -0
- package/genome/skills/add-template/SKILL.md +64 -0
- package/genome/skills/add-test-requirement/SKILL.md +73 -0
- package/genome/skills/analyze-2-func-specs/SKILL.md +101 -0
- package/genome/skills/analyze-func-specs/SKILL.md +123 -0
- package/genome/skills/analyze-if-func-spec-too-complex/SKILL.md +211 -0
- package/genome/skills/break-down-func-spec/SKILL.md +205 -0
- package/genome/skills/brood/SKILL.md +229 -0
- package/genome/skills/brood/references/intent.md +35 -0
- package/genome/skills/brood/references/product.md +101 -0
- package/genome/skills/brood/references/stack.md +61 -0
- package/genome/skills/brood/references/testing.md +56 -0
- package/genome/skills/bud/SKILL.md +148 -0
- package/genome/skills/bud/references/checklist.md +44 -0
- package/genome/skills/bud/references/intent.md +30 -0
- package/genome/skills/check-plain-env/SKILL.md +285 -0
- package/genome/skills/consolidate-concepts/SKILL.md +192 -0
- package/genome/skills/create-import-module/SKILL.md +104 -0
- package/genome/skills/create-requires-module/SKILL.md +109 -0
- package/genome/skills/debug-specs/SKILL.md +188 -0
- package/genome/skills/implement-conformance-testing-script/SKILL.md +238 -0
- package/genome/skills/implement-conformance-testing-script/assets/run_conformance_tests_cypress.ps1 +337 -0
- package/genome/skills/implement-conformance-testing-script/assets/run_conformance_tests_golang.ps1 +111 -0
- package/genome/skills/implement-conformance-testing-script/assets/run_conformance_tests_java.sh +136 -0
- package/genome/skills/implement-conformance-testing-script/assets/run_conformance_tests_python.ps1 +103 -0
- package/genome/skills/implement-conformance-testing-script/assets/run_conformance_tests_python.sh +150 -0
- package/genome/skills/implement-unit-testing-script/SKILL.md +160 -0
- package/genome/skills/implement-unit-testing-script/assets/run_unittests_flutter.ps1 +87 -0
- package/genome/skills/implement-unit-testing-script/assets/run_unittests_golang.ps1 +73 -0
- package/genome/skills/implement-unit-testing-script/assets/run_unittests_java.sh +72 -0
- package/genome/skills/implement-unit-testing-script/assets/run_unittests_python.ps1 +81 -0
- package/genome/skills/implement-unit-testing-script/assets/run_unittests_python.sh +98 -0
- package/genome/skills/implement-unit-testing-script/assets/run_unittests_react.ps1 +87 -0
- package/genome/skills/init-plain-project/SKILL.md +117 -0
- package/genome/skills/init-plain-project/references/checklist.md +30 -0
- package/genome/skills/mature/SKILL.md +126 -0
- package/genome/skills/refactor-module/SKILL.md +196 -0
- package/genome/skills/resolve-section-ownership/SKILL.md +64 -0
- package/genome/skills/resolve-spec-conflict/SKILL.md +96 -0
- package/genome/skills/spawn/SKILL.md +163 -0
- package/package.json +68 -4
- package/stdlib/backend/common.plain +25 -0
- package/stdlib/backend/conformance/common.plain +12 -0
- package/stdlib/backend/conformance/go-gin.plain +9 -0
- package/stdlib/backend/conformance/go-nethttp.plain +9 -0
- package/stdlib/backend/conformance/java-springboot.plain +9 -0
- package/stdlib/backend/conformance/python-django.plain +9 -0
- package/stdlib/backend/conformance/python-fastapi.plain +9 -0
- package/stdlib/backend/conformance/python-flask.plain +9 -0
- package/stdlib/backend/conformance/rust-axum.plain +9 -0
- package/stdlib/backend/conformance/typescript-express.plain +9 -0
- package/stdlib/backend/conformance/typescript-fastify.plain +9 -0
- package/stdlib/backend/conformance/typescript-nestjs.plain +9 -0
- package/stdlib/backend/go-gin.plain +18 -0
- package/stdlib/backend/go-nethttp.plain +18 -0
- package/stdlib/backend/java-springboot.plain +19 -0
- package/stdlib/backend/python-django.plain +19 -0
- package/stdlib/backend/python-fastapi.plain +23 -0
- package/stdlib/backend/python-flask.plain +23 -0
- package/stdlib/backend/rust-axum.plain +17 -0
- package/stdlib/backend/typescript-express.plain +19 -0
- package/stdlib/backend/typescript-fastify.plain +19 -0
- package/stdlib/backend/typescript-nestjs.plain +19 -0
- package/stdlib/cli/common.plain +17 -0
- package/stdlib/cli/conformance/common.plain +11 -0
- package/stdlib/cli/conformance/go-cobra.plain +9 -0
- package/stdlib/cli/conformance/go-flag.plain +9 -0
- package/stdlib/cli/conformance/java-picocli.plain +9 -0
- package/stdlib/cli/conformance/python-argparse.plain +9 -0
- package/stdlib/cli/conformance/python-click.plain +9 -0
- package/stdlib/cli/conformance/python-typer.plain +9 -0
- package/stdlib/cli/conformance/rust-clap.plain +9 -0
- package/stdlib/cli/conformance/typescript-commander.plain +9 -0
- package/stdlib/cli/go-cobra.plain +14 -0
- package/stdlib/cli/go-flag.plain +14 -0
- package/stdlib/cli/java-picocli.plain +15 -0
- package/stdlib/cli/python-argparse.plain +18 -0
- package/stdlib/cli/python-click.plain +16 -0
- package/stdlib/cli/python-typer.plain +16 -0
- package/stdlib/cli/rust-clap.plain +14 -0
- package/stdlib/cli/typescript-commander.plain +17 -0
- package/stdlib/frontend/angular.plain +17 -0
- package/stdlib/frontend/common.plain +17 -0
- package/stdlib/frontend/conformance/angular.plain +5 -0
- package/stdlib/frontend/conformance/common.plain +11 -0
- package/stdlib/frontend/conformance/react-vite.plain +5 -0
- package/stdlib/frontend/conformance/sveltekit-spa.plain +5 -0
- package/stdlib/frontend/conformance/vue-vite.plain +5 -0
- package/stdlib/frontend/react-vite.plain +16 -0
- package/stdlib/frontend/sveltekit-spa.plain +16 -0
- package/stdlib/frontend/vue-vite.plain +16 -0
- package/stdlib/lang/go.plain +13 -0
- package/stdlib/lang/java.plain +12 -0
- package/stdlib/lang/python.plain +18 -0
- package/stdlib/lang/rust.plain +12 -0
- package/stdlib/lang/typescript.plain +13 -0
- package/stdlib/library/common.plain +15 -0
- package/stdlib/library/conformance/common.plain +9 -0
- package/stdlib/library/conformance/go.plain +9 -0
- package/stdlib/library/conformance/java-gradle.plain +9 -0
- package/stdlib/library/conformance/java-maven.plain +9 -0
- package/stdlib/library/conformance/python.plain +9 -0
- package/stdlib/library/conformance/rust.plain +9 -0
- package/stdlib/library/conformance/typescript.plain +9 -0
- package/stdlib/library/go.plain +12 -0
- package/stdlib/library/java-gradle.plain +13 -0
- package/stdlib/library/java-maven.plain +13 -0
- package/stdlib/library/python.plain +13 -0
- package/stdlib/library/rust.plain +12 -0
- package/stdlib/library/typescript.plain +15 -0
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# the intent phase — What is the intent?
|
|
2
|
+
|
|
3
|
+
Extract the user's intent before creating files or decomposing the product into specifications.
|
|
4
|
+
Keep this phase short. Ask exactly five core questions, one at a time, and do not write to disk.
|
|
5
|
+
|
|
6
|
+
The harness has already asked the first question of this phase: how many questions the stack and
|
|
7
|
+
product phases may ask - light (3), medium (5), thorough (10) or best judgement. Do not ask it
|
|
8
|
+
again; this phase's own questions are not capped by it.
|
|
9
|
+
|
|
10
|
+
## Questions
|
|
11
|
+
|
|
12
|
+
1. **Problem** — What problem should this software solve?
|
|
13
|
+
2. **Primary user** — Who is it mainly for?
|
|
14
|
+
3. **Desired outcome** — What should that user be able to accomplish with it?
|
|
15
|
+
4. **Success criterion** — What observable result would make the first version useful?
|
|
16
|
+
5. **Initial boundary** — What should the first version deliberately leave out?
|
|
17
|
+
|
|
18
|
+
Ask one focused follow-up only when an answer is too vague to summarize. Do not explore features,
|
|
19
|
+
entities, technology, architecture, or testing yet; those belong to later phases.
|
|
20
|
+
|
|
21
|
+
## Intent brief
|
|
22
|
+
|
|
23
|
+
Summarize the answers in five short bullets:
|
|
24
|
+
|
|
25
|
+
- Problem
|
|
26
|
+
- Primary user
|
|
27
|
+
- Desired outcome
|
|
28
|
+
- Observable success criterion
|
|
29
|
+
- Initial boundary and explicit exclusions
|
|
30
|
+
|
|
31
|
+
Ask the user to confirm or correct the brief with one `ask_user` question, the five bullets passed whole as its
|
|
32
|
+
`context` - the dialog shows only the question, its options and its `context`. The intent phase finishes only after
|
|
33
|
+
explicit confirmation.
|
|
34
|
+
Carry the confirmed brief into the stack and product phases so their questions refine it instead of restarting intent
|
|
35
|
+
discovery.
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# the product phase — What does it do?
|
|
2
|
+
|
|
3
|
+
The whole product interview, in one phase, walked **feature by feature** - not section by
|
|
4
|
+
section. There is no pass that fills in the definitions and then another that writes the
|
|
5
|
+
functional specs. Each question is about the product: a feature, a step in a flow, a rule.
|
|
6
|
+
Its answer becomes one spec change that touches whatever sections that answer needs - the
|
|
7
|
+
concepts the feature introduces, a policy it needs, its functional spec - and every spec change
|
|
8
|
+
is built the moment it is written.
|
|
9
|
+
|
|
10
|
+
Carry the confirmed intent brief and the settled stack in. Do not restart either.
|
|
11
|
+
|
|
12
|
+
## How many questions
|
|
13
|
+
|
|
14
|
+
The questioning level caps this phase's questions (light 3, medium 5, thorough 10, or best
|
|
15
|
+
judgement - `SKILL.md`, "How many questions"), and so sets how broad each is. Every level walks
|
|
16
|
+
all the topics below: light in a few broad questions - the features and their order in one, what
|
|
17
|
+
they do end to end in another, with what fits the brief proposed for the person to confirm or
|
|
18
|
+
correct; thorough in narrow ones, a feature, rule or edge case each. The level limits the
|
|
19
|
+
questions, never the spec changes:
|
|
20
|
+
|
|
21
|
+
- **Every answer is a spec change**, at every level: written with `write_spec_diff` and built at
|
|
22
|
+
once, before the next question - `ask_user` refuses the next question until it is. A broad
|
|
23
|
+
answer covering several features is a change for each.
|
|
24
|
+
- **What the questions leave open is yours** - the details under a broad answer, and everything
|
|
25
|
+
still open once the questions are over (the cap reached, or `end_questions` called). Each
|
|
26
|
+
feature, edge case and rule you decide is its own spec change, written with `write_spec_diff`
|
|
27
|
+
with no answer needed before it, and said in one line. Write as many as the product needs.
|
|
28
|
+
Decide from the intent brief and the answers so far; leave out what they do not call for rather
|
|
29
|
+
than invent scope.
|
|
30
|
+
|
|
31
|
+
## One question, one answer, a spec change, a render
|
|
32
|
+
|
|
33
|
+
Every iteration is exactly this, at every questioning level:
|
|
34
|
+
|
|
35
|
+
1. **Ask one question** with `ask_user`, about the product: a feature, its trigger and outcome,
|
|
36
|
+
one of its edge cases or rules, the next step of a flow - as broad as the level says. Never bundle two, and never ask about
|
|
37
|
+
a spec section ("what concepts are there?", "what reqs apply?") - ask about what the product
|
|
38
|
+
does, and let the answer decide which sections change.
|
|
39
|
+
2. **Turn the answer into a spec change** - one for each feature it covers - everything it calls for, across sections:
|
|
40
|
+
- a concept the feature introduces, into `***definitions***`, following `add-concept`, defined
|
|
41
|
+
in the same change as the functional spec that first uses it;
|
|
42
|
+
- a technology-free policy the answer states, into `***implementation reqs***`;
|
|
43
|
+
- the functional spec for the feature, or the change to one already written, following
|
|
44
|
+
`add-functional-spec`.
|
|
45
|
+
Write it as a git diff of the `.plain` file(s): `diff --git a/<file> b/<file>`,
|
|
46
|
+
`--- a/<file>`, `+++ b/<file>`, then the hunks with a few lines of unchanged context. Paths
|
|
47
|
+
are relative to the project root.
|
|
48
|
+
3. **Write it with `write_spec_diff`.** It applies the diff and starts a render spec diff job for
|
|
49
|
+
it in the same call - whatever the change touches, a definition alone included. Write every
|
|
50
|
+
change the answer calls for before the next question - `ask_user` refuses it until then - and
|
|
51
|
+
any you decide yourself beside them. Move straight on to the next question; never wait for a
|
|
52
|
+
build.
|
|
53
|
+
|
|
54
|
+
**One answer, at least one change.** A follow-up about the same feature - an edge case, a
|
|
55
|
+
validation rule - is its own answer and its own change to that feature's spec. An answer that
|
|
56
|
+
describes two features is two changes, both written before the next question. A change never
|
|
57
|
+
carries both an answer and something you decided: what you decide is a change of its own.
|
|
58
|
+
|
|
59
|
+
**Fix contradictions in place.** When a later answer refines or contradicts something already
|
|
60
|
+
written, write the correction as its own diff with `fixes_earlier` set, before the next
|
|
61
|
+
question. It is rendered like any other change.
|
|
62
|
+
|
|
63
|
+
**Never edit the `.plain` files with `write` or `edit` in this phase.** A change that does not
|
|
64
|
+
go through `write_spec_diff` is a change nothing renders.
|
|
65
|
+
|
|
66
|
+
## What a change may contain
|
|
67
|
+
|
|
68
|
+
- **`***definitions***`** - the concepts the change needs, each defined before, or in the same
|
|
69
|
+
change as, what first uses it.
|
|
70
|
+
- **`***functional specs***`** - at most one new functionality per change: ≤200 lines of code
|
|
71
|
+
change, language-agnostic, in chronological build order, externally explicit where it has an
|
|
72
|
+
interface.
|
|
73
|
+
- **`***implementation reqs***`** - only technology-free policy: an error-handling or retry
|
|
74
|
+
policy, an ordering guarantee, a data-format rule. The technology was settled in the stack
|
|
75
|
+
phase; an answer that needs a new technology is a stack answer - note it and steer back.
|
|
76
|
+
|
|
77
|
+
Leave the `***test reqs***` as the testing phase wrote them, and write no `***acceptance tests***`.
|
|
78
|
+
With conformance on, every change is built with its conformance tests - from the test reqs as they
|
|
79
|
+
stand.
|
|
80
|
+
|
|
81
|
+
## Topics (in order)
|
|
82
|
+
|
|
83
|
+
1. **Product description** - propose a one-sentence description from the confirmed intent brief,
|
|
84
|
+
state it back in one line, and write it into the frontmatter as the first change.
|
|
85
|
+
2. **Features, one at a time, in build order** - the smallest thing that is useful first, then
|
|
86
|
+
what builds on it. For each feature: one question for what triggers it and what comes out,
|
|
87
|
+
then one per edge case, validation rule or permission that is not obvious. Each answer is a
|
|
88
|
+
change: the first brings the feature's concepts and its functional spec; the follow-ups refine
|
|
89
|
+
them. A feature too large for one functional spec is split *with the user* - that is the next
|
|
90
|
+
question.
|
|
91
|
+
3. **User flows** - walk the product from the user's side: what happens first, what next, and at
|
|
92
|
+
each decision point. Each missing step is a feature, taken the same way.
|
|
93
|
+
4. **User interface (optional)** - skip entirely if there is none. Otherwise per screen or
|
|
94
|
+
interaction: what the user sees and what it does, still language- and framework-agnostic.
|
|
95
|
+
5. **Anything else** - anything the user wants to add or change that has not been covered.
|
|
96
|
+
|
|
97
|
+
## Reporting builds
|
|
98
|
+
|
|
99
|
+
Report each build result between questions, in one sentence. A failed build does not stop the
|
|
100
|
+
interview - note it and carry on, unless it shows the spec itself is wrong, in which case fix
|
|
101
|
+
the spec with a diff and `fixes_earlier`.
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# the stack phase — What technologies should it use?
|
|
2
|
+
|
|
3
|
+
Gather the technical stack **and** the project's structure/architecture. This phase affects only `***implementation reqs***`, and ends with the unit testing script every build needs — the rest of testing comes later. Run the core loop from `SKILL.md` for each topic below, in order: ask, then write the requirement into the `.plain` file with the ordinary file tools. Nothing is built in this phase. When the user has no preference, propose a sensible default that fits earlier answers and ask them to confirm.
|
|
4
|
+
|
|
5
|
+
The questioning level caps this phase's questions (light 3, medium 5, thorough 10, or best
|
|
6
|
+
judgement - `SKILL.md`, "How many questions"), and so sets how broad each is. Every level reaches
|
|
7
|
+
all the topics, in order: light in a few broad questions - the stack, say, then storage and
|
|
8
|
+
outside services together, then the remaining constraints, each with what fits the brief
|
|
9
|
+
proposed; thorough a topic or two a question, with follow-ups. Every topic left unasked once the
|
|
10
|
+
questions are over gets the default that fits the intent brief and the answers so far, written as a
|
|
11
|
+
requirement like any other and named as your choice in the closing summary. The unit testing script
|
|
12
|
+
is written whatever the level.
|
|
13
|
+
|
|
14
|
+
## Author target for this phase
|
|
15
|
+
|
|
16
|
+
Write each requirement into `***implementation reqs***`:
|
|
17
|
+
|
|
18
|
+
- Shared, stack-wide reqs (language, framework, architecture, coding standards) go on the template module if one exists.
|
|
19
|
+
- Module-specific reqs (e.g. a data-storage choice or an external integration only one module uses) go on the module that needs them.
|
|
20
|
+
|
|
21
|
+
Do **not** add `***test reqs***` or `***acceptance tests***` in this phase — the test reqs belong to the testing phase, right after this one.
|
|
22
|
+
|
|
23
|
+
## First: a stack from the standard library
|
|
24
|
+
|
|
25
|
+
Before the topics, settle what kind of software each module is - a backend, a frontend, a
|
|
26
|
+
command-line tool, a library - and offer the standard library's stacks for that kind (the stdlib
|
|
27
|
+
rule, in `<plain-rules>`, lists them) that this machine can build: `<toolchains on this machine>`, in
|
|
28
|
+
your instructions, says which languages it can build now. The agents use its toolchains and install
|
|
29
|
+
none, so a stack in a language it lacks stops at its first build. Ask with `ask_user`: those stacks
|
|
30
|
+
as options, the one that fits earlier answers first, and "Something else…" for a stack of the user's
|
|
31
|
+
own. A stack the user names in a language the machine lacks: say what to install first and that
|
|
32
|
+
`turri doctor` checks it, and ask whether to wait for that or choose another.
|
|
33
|
+
|
|
34
|
+
- **A stack from the standard library.** Import it into the module's frontmatter as
|
|
35
|
+
`stdlib/<kind>/<stack>`, and read the templates it brings: the stack, its `stdlib/lang/<language>`
|
|
36
|
+
and its kind's `common` - the folder is in the stdlib rule. They settle topics 1, 2 and 5, error handling and
|
|
37
|
+
logging in topic 6, and the unit-test framework in topic 8: do not ask about those, and write no
|
|
38
|
+
requirement that restates them. Say in one line what the stack settles - its language, framework,
|
|
39
|
+
layout, how it reports errors and logs - so the user knows what they chose. Then walk only topics
|
|
40
|
+
3, 4, 6 (what the stack leaves open), 7, and the unit testing script in 8.
|
|
41
|
+
- **Something else.** Walk every topic below. When the language is one the standard library has, its
|
|
42
|
+
`stdlib/lang/<language>` template can still be imported for the language-wide conventions.
|
|
43
|
+
|
|
44
|
+
A user who wants something the stack settles done differently - another framework, another layout -
|
|
45
|
+
has chosen something else: an import cannot be taken back in part.
|
|
46
|
+
|
|
47
|
+
## Topics (in order)
|
|
48
|
+
|
|
49
|
+
1. **Programming language** — e.g. Python, TypeScript, Java, Go. Author a language requirement at the appropriate scope (template if shared across modules, otherwise on the module). Review that requirement snippet.
|
|
50
|
+
2. **Frameworks** — e.g. Flask, FastAPI, Next.js, Spring Boot, Express, React, Vue. Author framework requirement(s) and any framework-specific architectural conventions. Review the new framework reqs.
|
|
51
|
+
3. **Data storage** — e.g. PostgreSQL, SQLite, file-based, in-memory, none. Author a storage requirement on the module that owns persistence (or the template if shared). Review that snippet.
|
|
52
|
+
4. **External services or APIs** — anything the app talks to: auth providers, payment gateways, email/SMS, third-party APIs, internal services. Author one requirement per integration on the module that uses it. Review each integration snippet.
|
|
53
|
+
5. **Project structure & architecture** — the architectural style and the layers/components the project should be organized into (managers, services, models, repositories, controllers, views, adapters, DTOs, …). Discuss naming conventions, directory layout, and the responsibilities/boundaries of each layer. If the user has no preference, propose a layout that fits the language, framework, and feature set, and confirm it. Author architecture/layering reqs in the template (if shared) and any module-specific deviations on the module. Review the architecture reqs and the resulting layer split.
|
|
54
|
+
6. **Other constraints** — deployment target, OS requirements, performance needs, coding standards, security policies, observability — anything stack-wide that hasn't already been covered. Author each constraint as its own requirement at the appropriate scope. Review the new constraint snippets.
|
|
55
|
+
7. **Anything else** — anything the user wants to add or change that hasn't already been covered.
|
|
56
|
+
8. **Unit tests and their script** — last, once the stack is settled: the first build needs both.
|
|
57
|
+
- The unit-test framework, e.g. pytest, Jest, JUnit, Go's `testing` package. Suggest one that fits the language if the user has no preference. Author a `:UnitTests:` requirement in `***implementation reqs***` at the appropriate scope - e.g. "`:UnitTests:` should use pytest" plus how they are run. Review that snippet.
|
|
58
|
+
- The unit testing script. If turri already finds one - named by `unittests-script:` in `config.turri.yaml` at the project root (or in the stack's `config.turri.<stack>.yaml`, in a project whose parts are on different stacks), or the one `run_unittests*.sh` in the root or in `test_scripts/` - keep it. Otherwise generate `test_scripts/run_unittests_<language>.sh` (and any framework config it needs, e.g. `pytest.ini`) via `implement-unit-testing-script`. Do not link it from the specs. Without it, every build stops before it starts. Review the script's path and what it runs.
|
|
59
|
+
- The static checks, in that script: the formatter in check mode, the linter and the type checker the stack names, run with the unit tests and counting as they do - `implement-unit-testing-script` says which for each language. A unit testing script turri already finds that runs none is extended with them. There is no separate static checks script.
|
|
60
|
+
|
|
61
|
+
When all topics are complete, summarize the full tech stack and the chosen architecture, and get an explicit overall confirmation before moving to the product phase.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# the testing phase — How is what was built checked from the outside?
|
|
2
|
+
|
|
3
|
+
Decide whether the project has conformance tests, and if it does, say in `***test reqs***` how they
|
|
4
|
+
are written and run, and give it the script that runs them. This comes before the product phase, and
|
|
5
|
+
nothing here is built: a change to the test reqs is not a spec diff, so it is written with the
|
|
6
|
+
ordinary file tools, never `write_spec_diff`. What is settled here is what every build of the
|
|
7
|
+
product phase follows - with conformance on, each spec change is built with its conformance tests.
|
|
8
|
+
Run the core loop for each topic below, in order: ask, then write. When the user has no preference,
|
|
9
|
+
propose a default that fits the stack and the intent brief and ask them to confirm.
|
|
10
|
+
|
|
11
|
+
Conformance tests are black-box tests written from the spec: for each functional spec, tests that
|
|
12
|
+
run the built software from the outside - as a command, over HTTP, through its public entry point -
|
|
13
|
+
and check it does what the spec says, kept apart from the spec's acceptance tests. The harness runs
|
|
14
|
+
the whole suite after every spec change, so they catch one change breaking another. They cost time
|
|
15
|
+
and tokens on every build.
|
|
16
|
+
|
|
17
|
+
## Author target for this phase
|
|
18
|
+
|
|
19
|
+
- `***test reqs***` - one `:ConformanceTests:` requirement per fact, on the template if one exists
|
|
20
|
+
(shared by every module), otherwise on the module. Follow `genome/rules/test-reqs.md`.
|
|
21
|
+
- `config.turri.yaml` at the project root - the `conformance-tests:` decision. Change only that key, and
|
|
22
|
+
create the file if there is none; everything else in it stays as it is. When the project has only a
|
|
23
|
+
`config.yaml`, copy it to `config.turri.yaml` first - and each `config.<name>.yaml` to
|
|
24
|
+
`config.turri.<name>.yaml` - and write the copy: `config.yaml` may be another tool's, and is never
|
|
25
|
+
written.
|
|
26
|
+
- `test_scripts/` - the conformance testing script.
|
|
27
|
+
|
|
28
|
+
Write no `***acceptance tests***`, no functional specs and no `***implementation reqs***` here.
|
|
29
|
+
|
|
30
|
+
## Topics (in order)
|
|
31
|
+
|
|
32
|
+
1. **Conformance on or off** - ask it explicitly, with what it costs and what it catches; it is a
|
|
33
|
+
recorded decision, never an inference. Ask it even when `config.turri.yaml` already has
|
|
34
|
+
`conformance-tests:` - offer what it says as the first option. Write it to `config.turri.yaml` as `conformance-tests: true` or
|
|
35
|
+
`conformance-tests: false`. Off: say that no conformance tests will be written or run until it
|
|
36
|
+
is turned on, and go to the end of the phase.
|
|
37
|
+
2. **Framework** - e.g. pytest, JUnit, Jest, Go's `testing`; one that fits the stack. Author it as a
|
|
38
|
+
`:ConformanceTests:` requirement.
|
|
39
|
+
3. **How the tests reach the software** - as a subprocess of the CLI, over HTTP against a server the
|
|
40
|
+
tests start, through the public entry point it exports. Author it.
|
|
41
|
+
4. **Setup and outside services** - fixtures, test data, databases, third-party APIs: started for
|
|
42
|
+
real, faked, or mocked at the boundary. Author each decision as its own requirement.
|
|
43
|
+
5. **How the whole suite is run** - the one command that discovers every test. Author it.
|
|
44
|
+
6. **The conformance testing script** - if turri already finds one (named by
|
|
45
|
+
`conformance-tests-script:` in `config.turri.yaml`, or the one `run_conformance_tests*.sh` in the
|
|
46
|
+
project root or in `test_scripts/`), check it runs the suite the way the test reqs now say, and
|
|
47
|
+
keep it. Otherwise write `test_scripts/run_conformance_tests_<language>.sh` with
|
|
48
|
+
`implement-conformance-testing-script`, to match the test reqs. Never link it from the specs.
|
|
49
|
+
If `test_scripts/` would hold two of a kind, name the one to use in `config.turri.yaml`. In a
|
|
50
|
+
project whose parts are on different stacks, name each stack's script in its own
|
|
51
|
+
`config.turri.<stack>.yaml` (`conformance-tests-script:`), and tell the user to choose the stack
|
|
52
|
+
with `/stack <stack>` (`--stack <stack>` on the command line) before building that part.
|
|
53
|
+
7. **Anything else** - anything about testing the user wants to add or change.
|
|
54
|
+
|
|
55
|
+
Run `validate` on every module you changed. The product phase's first build needs the test reqs
|
|
56
|
+
and the conformance testing script both there: without them it stops before it starts.
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: bud
|
|
3
|
+
description: >-
|
|
4
|
+
Add a feature to an existing ***plain project the way `brood` builds one: a short
|
|
5
|
+
feature-intent interview, then product questions one at a time - a trigger and its outcome, an
|
|
6
|
+
edge case, a rule - where every answer becomes one spec change, written as a git diff of the
|
|
7
|
+
.plain files and built the moment it is written, so the feature appears while the interview is
|
|
8
|
+
still going. A change that touches what is already specified or being built is a spec diff too: what
|
|
9
|
+
is left to build is worked out again from the spec. Use when the user wants to add a
|
|
10
|
+
feature to an existing project. Not for starting a new project (use `brood`, or `spawn`
|
|
11
|
+
to start fast) or for editing generated code (the .plain specs are the source of truth).
|
|
12
|
+
allowed-tools: [read, write, edit, bash, ls, grep, find, write_spec_diff]
|
|
13
|
+
metadata:
|
|
14
|
+
# What each phase does, in a line - shown under the skill's progress while it runs.
|
|
15
|
+
phases:
|
|
16
|
+
intent: "what the feature is for, who it serves, and what it leaves out"
|
|
17
|
+
scope: "finds where the feature goes in the spec, and what is built already"
|
|
18
|
+
product: "the feature, question by question - each answer starts a regenerate pulse"
|
|
19
|
+
review: "checks the changed spec holds together, then hands over"
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
# Bud
|
|
23
|
+
|
|
24
|
+
Load the `***plain` syntax rules before writing anything - they are in the system prompt under
|
|
25
|
+
`<plain-rules>`; read `genome/rules/<name>.md` for the full text of any rule you need to follow
|
|
26
|
+
closely.
|
|
27
|
+
|
|
28
|
+
## Role
|
|
29
|
+
|
|
30
|
+
Act as a `***plain` spec writer adding one feature to specs that already exist - and, usually, to
|
|
31
|
+
code already built from them, or being built. The only output is changes to `.plain` files, and
|
|
32
|
+
every one of them is a **spec diff**: a git diff of the `.plain` files, written with
|
|
33
|
+
`write_spec_diff`, which applies it and queues its render spec diff job. Never write code, and never
|
|
34
|
+
change a `.plain` file by any other means. Frame every message in terms of specs: "I'll add this to
|
|
35
|
+
the spec."
|
|
36
|
+
|
|
37
|
+
This is `brood`'s product phase, scoped to one feature, on top of what is there: the stack,
|
|
38
|
+
the testing setup and every earlier feature are settled - read them, build on them, restart none.
|
|
39
|
+
|
|
40
|
+
## Question style
|
|
41
|
+
|
|
42
|
+
- Ask with `ask_user`, one question per call, and pass `options` so the user picks rather than
|
|
43
|
+
types - concrete choices, plus the free-form catch-all the tool adds. Reserve `free_form: true`
|
|
44
|
+
for a genuinely open question.
|
|
45
|
+
- Ask about the product - a trigger and its outcome, an edge case, a rule, a permission, a step of
|
|
46
|
+
a flow - never about a spec section ("which concepts?", "what reqs?"). Let the answer decide which
|
|
47
|
+
sections change.
|
|
48
|
+
- Shape each question so any plausible answer maps to one spec change. Bad: "How should it work?"
|
|
49
|
+
Good: "When the title is empty, should saving be refused with `Title is required`, or saved as
|
|
50
|
+
`Untitled`?"
|
|
51
|
+
- Short, direct sentences and plain words; never drop a detail the user needs to answer - split into
|
|
52
|
+
more sentences instead.
|
|
53
|
+
|
|
54
|
+
## Steps
|
|
55
|
+
|
|
56
|
+
### intent
|
|
57
|
+
|
|
58
|
+
Read `references/intent.md` and ask its five core questions one at a time with `ask_user`. Ask at
|
|
59
|
+
most one focused follow-up when an answer is too vague to summarize. If what the user has already
|
|
60
|
+
said answers a question, confirm it in one line instead of asking.
|
|
61
|
+
|
|
62
|
+
Write nothing to disk. Summarize the feature-intent brief - motivation, affected user, desired
|
|
63
|
+
outcome, observable success criterion, boundary and explicit exclusions - and get explicit
|
|
64
|
+
confirmation, the brief passed whole as `ask_user`'s `context`, which the dialog shows above the
|
|
65
|
+
question. Carry the brief into every later step.
|
|
66
|
+
|
|
67
|
+
### scope
|
|
68
|
+
|
|
69
|
+
Keep this short: enough to ask the first product question, not a design on paper.
|
|
70
|
+
|
|
71
|
+
1. Find the `.plain` file(s) the feature belongs to, and read them whole, following their `import`
|
|
72
|
+
and `requires` chains: every definition, implementation and test req, functional spec and
|
|
73
|
+
acceptance test the feature will sit beside. Read `config.turri.yaml` (or the old `config.yaml`,
|
|
74
|
+
when there is no `config.turri.yaml`) and the chosen stack's `config.turri.<stack>.yaml` for
|
|
75
|
+
whether conformance tests are on.
|
|
76
|
+
2. Ask which module only if it is genuinely ambiguous; otherwise do not.
|
|
77
|
+
3. Look at what is built and queued (`drift`), so you know which specs already have code and
|
|
78
|
+
which builds are still waiting - a change to either is still just a spec diff.
|
|
79
|
+
|
|
80
|
+
Say in one line where the feature goes, and move on. Write nothing to disk.
|
|
81
|
+
|
|
82
|
+
### product
|
|
83
|
+
|
|
84
|
+
The feature, walked question by question. Run this loop until the user says the feature is fully
|
|
85
|
+
covered:
|
|
86
|
+
|
|
87
|
+
1. **Ask** one product question with `ask_user`.
|
|
88
|
+
2. The user **answers**.
|
|
89
|
+
3. **Make the spec change** the answer calls for, as one git diff of the `.plain` file(s) - across
|
|
90
|
+
every section it needs:
|
|
91
|
+
- a concept it introduces, into `***definitions***` - written the way `add-concept` says, and
|
|
92
|
+
defined in the same change as the functional spec that first uses it;
|
|
93
|
+
- a policy it states - error handling, a retry, a data format, a library not already in the
|
|
94
|
+
module or its imports - into `***implementation reqs***`, the way
|
|
95
|
+
`add-implementation-requirement` says;
|
|
96
|
+
- the functional spec it adds, or the change to one already written, the way
|
|
97
|
+
`add-functional-spec` says: its wording rules, its complexity check
|
|
98
|
+
(`analyze-if-func-spec-too-complex` - at most 200 lines of code; a spec too big is split *with
|
|
99
|
+
the user*, as the next question) and its conflict check (`analyze-func-specs`, over the new
|
|
100
|
+
spec and every existing one in the chain). Follow those skills for what the text is; the diff
|
|
101
|
+
is the only thing that writes it.
|
|
102
|
+
- with conformance tests on - test reqs of the module's own or imported, and a conformance
|
|
103
|
+
testing script turri finds - an acceptance test under its functional spec when the
|
|
104
|
+
answer states one concrete verification (`add-acceptance-test`), and a test req only when the
|
|
105
|
+
answer changes how conformance tests run (`add-test-requirement`). With conformance off, none.
|
|
106
|
+
Write it as a git diff: `diff --git a/<file> b/<file>`, `--- a/<file>`, `+++ b/<file>`, then the
|
|
107
|
+
hunks with a few lines of unchanged context, paths from the project root. A new functional spec
|
|
108
|
+
goes where it belongs in build order - after what it builds on, usually at the end.
|
|
109
|
+
4. **Write it with `write_spec_diff`.** It applies the diff and queues a render spec diff job for
|
|
110
|
+
it; with conformance on, its conformance tests follow it. Say in one line what went into the
|
|
111
|
+
spec - "added `:Note:` and functional spec 7" - and what became of the build, as the tool says,
|
|
112
|
+
then ask the next question. Never wait for a build, and never ask the user to approve a change.
|
|
113
|
+
|
|
114
|
+
**One answer, one change.** A follow-up about the same behavior - an edge case, a validation rule -
|
|
115
|
+
is its own answer and its own change. An answer that describes two behaviors is two: write the
|
|
116
|
+
first, then ask about the second. A change never carries anything the user was not asked about.
|
|
117
|
+
|
|
118
|
+
**What already exists.** When an answer - or the conflict check - means changing something already
|
|
119
|
+
specified: a definition, a req, a functional spec, built or still queued, the next question is
|
|
120
|
+
about exactly that. Quote the existing text and offer: keep it (narrow what was just written),
|
|
121
|
+
augment it (with the new wording in the question), or replace it. The answer is a spec diff like
|
|
122
|
+
any other, written with `fixes_earlier`; when a concept changes, the same diff updates every spec
|
|
123
|
+
that uses it, within what the user approved. Never rewrite earlier intent without asking. The queue
|
|
124
|
+
master reworks the builds still queued around every such change - a queued build the change undoes
|
|
125
|
+
is taken out, one it touches renders the spec as it now is.
|
|
126
|
+
|
|
127
|
+
**Fix your own mistakes in place.** When a later answer refines or contradicts a change you wrote in
|
|
128
|
+
this feature, write the correction as its own diff with `fixes_earlier`, before the next question.
|
|
129
|
+
|
|
130
|
+
When the loop reaches the end of what the brief covers, ask whether the feature is fully covered.
|
|
131
|
+
Yes: go to the review. No: the next question.
|
|
132
|
+
|
|
133
|
+
### review
|
|
134
|
+
|
|
135
|
+
A short consistency pass over what the feature changed, then the handover.
|
|
136
|
+
|
|
137
|
+
1. Read the modified `.plain` file(s) whole, and check: every new concept defined before use, with
|
|
138
|
+
no cycles; build order right end to end - no spec depends on one after it; functional specs
|
|
139
|
+
language-agnostic; every external interface explicit (paths, methods, arguments, formats);
|
|
140
|
+
acceptance tests consistent with their functional specs.
|
|
141
|
+
2. Run `validate` on every module the feature touched.
|
|
142
|
+
3. Fix what either finds with a spec diff and `fixes_earlier` - never by editing the file. Ask the
|
|
143
|
+
user only when a fix is a decision the brief and the answers do not settle.
|
|
144
|
+
|
|
145
|
+
Walk `references/checklist.md` once, as a self-audit. Then hand over in a few lines: the feature's
|
|
146
|
+
spec changes in order, the builds they queued and how they stand (`drift`), and that any
|
|
147
|
+
further change is asked for in the conversation - each one a spec diff, and what is left to build is
|
|
148
|
+
worked out again from the spec. The next feature starts again from the intent.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Bud Checklist
|
|
2
|
+
|
|
3
|
+
Use this to verify the workflow was followed - never as a substitute for it. Walk it once in the
|
|
4
|
+
review step, before the handover. A box counts only when the change is in the `.plain` files, not
|
|
5
|
+
merely discussed; an unmet box is completed with a spec diff before finishing.
|
|
6
|
+
|
|
7
|
+
## Intent
|
|
8
|
+
|
|
9
|
+
- [ ] Asked the five core questions of `references/intent.md` one at a time - or confirmed in one
|
|
10
|
+
line what the user had already said - with at most one clarification for a vague answer.
|
|
11
|
+
- [ ] Wrote nothing to disk before the brief was confirmed.
|
|
12
|
+
- [ ] Summarized motivation, affected user, desired outcome, observable success criterion, and
|
|
13
|
+
boundary with explicit exclusions; got explicit confirmation.
|
|
14
|
+
|
|
15
|
+
## Scope
|
|
16
|
+
|
|
17
|
+
- [ ] Read the target `.plain` file(s) whole, with their `import` and `requires` chains, and the
|
|
18
|
+
config that says whether conformance tests are on.
|
|
19
|
+
- [ ] Asked which module only when it was genuinely ambiguous.
|
|
20
|
+
|
|
21
|
+
## Every product question
|
|
22
|
+
|
|
23
|
+
- [ ] Asked exactly one question via `ask_user`, about the product - a trigger and outcome, an edge
|
|
24
|
+
case, a rule, a permission, a step of a flow - never about a spec section.
|
|
25
|
+
- [ ] Turned the answer into exactly one spec change, across every section it needed, and wrote it
|
|
26
|
+
with `write_spec_diff` - never with `write` or `edit`.
|
|
27
|
+
- [ ] Concepts defined in the same change as, or before, what first uses them; no cycles.
|
|
28
|
+
- [ ] Every functional spec follows `add-functional-spec`'s rules, passed its complexity and
|
|
29
|
+
conflict checks, and sits in build order; one too big was split with the user.
|
|
30
|
+
- [ ] Every change to something already specified - built or still queued - was put to the user
|
|
31
|
+
first (keep / augment / replace) and written as a diff with `fixes_earlier`.
|
|
32
|
+
- [ ] Every correction of this feature's own changes was a diff with `fixes_earlier`, before the
|
|
33
|
+
next question.
|
|
34
|
+
- [ ] `***test reqs***` and `***acceptance tests***` only with conformance tests on.
|
|
35
|
+
- [ ] Asked whether the feature is fully covered before leaving the loop.
|
|
36
|
+
|
|
37
|
+
## Review
|
|
38
|
+
|
|
39
|
+
- [ ] Read the modified `.plain` file(s) whole and checked: concepts defined before use, no cycles,
|
|
40
|
+
build order right end to end, functional specs language-agnostic, every external interface
|
|
41
|
+
explicit, acceptance tests consistent with their functional specs.
|
|
42
|
+
- [ ] Ran `validate` on every module touched, and fixed what it reported with spec diffs.
|
|
43
|
+
- [ ] Handed over: the spec changes in order, the builds they queued and how they stand, and that
|
|
44
|
+
further changes are asked for in the conversation as spec diffs.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# The intent step - what is the feature for?
|
|
2
|
+
|
|
3
|
+
Extract the intent of this feature before choosing files or authoring specifications. Ask exactly
|
|
4
|
+
five core questions, one at a time, and do not write to disk.
|
|
5
|
+
|
|
6
|
+
## Questions
|
|
7
|
+
|
|
8
|
+
1. **Motivation** — What problem or limitation should this feature address?
|
|
9
|
+
2. **Affected user** — Who should benefit from or interact with this feature?
|
|
10
|
+
3. **Desired outcome** — What should that user be able to accomplish after the feature exists?
|
|
11
|
+
4. **Success criterion** — What observable result would prove the feature is useful and working?
|
|
12
|
+
5. **Boundary** — What should this feature deliberately leave unchanged or out of scope?
|
|
13
|
+
|
|
14
|
+
Ask one focused follow-up only when an answer is too vague to summarize. Do not choose concepts,
|
|
15
|
+
spec wording, implementation technology, or tests yet - the product questions decide those, one
|
|
16
|
+
spec change at a time.
|
|
17
|
+
|
|
18
|
+
## Feature-intent brief
|
|
19
|
+
|
|
20
|
+
Summarize the answers in five short bullets:
|
|
21
|
+
|
|
22
|
+
- Motivation
|
|
23
|
+
- Affected user
|
|
24
|
+
- Desired outcome
|
|
25
|
+
- Observable success criterion
|
|
26
|
+
- Boundary and explicit exclusions
|
|
27
|
+
|
|
28
|
+
Ask the user to confirm or correct the brief. The intent step finishes only after explicit
|
|
29
|
+
confirmation. Carry the brief into the scope step, so it maps the intent onto existing modules
|
|
30
|
+
instead of restarting the feature discussion.
|