Add feature-notebook workflow: per-feature design specs + test results feeding PRs - #381
Merged
Conversation
…feature Every feature a coding agent implements now gets a numbered entry under notebook/ (gitignored, local-only): a design_spec.md written before coding (problem context from the session, proposed implementation with per-section DESIGN/TODO / WIP / DONE status labels, lettered test plan) and a results/ tree with per-section raw artifacts plus a self-contained results_summary.md (embedded tables + figures) that populates the feature's PR description. - New skill .agents/skills/use-feature-notebook with SKILL.md and design_spec / results_summary templates - AGENTS.md: skill registry row, notebook-first Agent Workflow Example, new "Feature Notebook" section - .gitignore: /notebook/ Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Adds docs/development/intermediate/feature_notebook.md (directory layout, 5-step workflow, status labels, local-only rule, notebook → PR flow), wires it into the mkdocs nav under Development > Intermediate Tutorials > Contributing, and lists it in the Development index. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Coding-agent sessions accumulate valuable context — the problem framing, design decisions, and validation evidence — that evaporates when the conversation ends. This PR adds a feature notebook workflow: every feature an agent implements gets a numbered entry under
notebook/at the repo root that records the design spec before coding and the test results after, and that content is what populates the feature's PR description.What changed
New skill:
.agents/skills/use-feature-notebook/SKILL.md— the workflow:notebook/NNN-feature-slug/design_spec.md— problem context from the session, proposed implementation, and a lettered test plan(a),(b), …DESIGN/TODO/WIP/DONElabel on each implementation subsectionresults/<letter>-<section-slug>/, letters matching the spec's test-plan sectionsresults/results_summary.md— self-contained, with quantitative tables and qualitative figures embedded directly, plus per-section verdictsassets/design_spec_template.mdandassets/results_summary_template.md— fill-in templatesAGENTS.mduse-feature-notebookrow in the skills registrynotebook/)" section with the directory layout and the local-only ruleDocs site
docs/development/intermediate/feature_notebook.mdunder Development → Intermediate Tutorials → Contributing (wired intomkdocs.ymlnav and listed in the Development index).gitignore/notebook/— the notebook is local-only on each developer's machine; its content leaves the machine only via PR descriptionsVersion
.envVERSION0.19.0-alpha.9→0.19.0-alpha.10, CHANGELOG entry under[Unreleased](docs/tooling-only change; bump clears the version gate)Validation
git check-ignore -v notebook/001-test→ matched by the new/notebook/rule🤖 Generated with Claude Code