docs: enforce spec-first beads/OpenSpec workflow#4
Open
richards-bot wants to merge 2 commits into
Open
Conversation
- brain-dump: make OpenSpec artifacts the mandatory primary output; docs/SPEC.md demoted to human-readable summary; add clarifying questions step before populating docs - start-bead: add step 3 gate — STOP if no OpenSpec artifact exists for non-trivial work; only trivial changes may bypass (must state why) - plan: hard STOP if neither openspec/changes/ nor openspec/specs/ exist; forbid planning from docs/SPEC.md alone - status: list openspec/ artifacts in output; warn if active bead is missing Spec source: linkage in notes - complete-bead: verify spec linkage before closing; add git push to the success path; never close when tests fail - GETTING-STARTED: add clean beads state verification after setup; explicit spec-first section (spec -> beads -> code order); document what brain-dump creates and in what order - README: clarify brain-dump creates OpenSpec artifacts as primary output; add post-setup beads verification; fix manual setup to also remove .beads.bak
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
1 participant
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.
Why\nThe template currently talks as if beads and OpenSpec are part of the operating model, but its command/docs flow still lets agents work from root docs alone and treat OpenSpec as optional placeholder scaffolding.\n\n## What this changes\n- makes OpenSpec artifacts the required source of truth for non-trivial work\n- updates /brain-dump to create real OpenSpec artifacts first\n- makes /plan and /start-bead stop when no real OpenSpec artifact exists\n- strengthens /status and /complete-bead around spec linkage and canonical beads checks\n- clarifies setup verification and spec-first workflow in README / GETTING-STARTED\n\n## Notes\n- intentionally does not commit a .beads directory into the template\n- keeps setup.sh clean-project behavior intact\n