feat: Require worked examples in designs; lead gate presentations with before→after - #31
Open
jirispilka wants to merge 1 commit into
Open
feat: Require worked examples in designs; lead gate presentations with before→after#31jirispilka wants to merge 1 commit into
jirispilka wants to merge 1 commit into
Conversation
…with before→after Designs must carry concrete before→after examples of the primary artifact, one per consequence-carrying decision; design-gate presentations lead with a "What changes at a glance" block. PR bodies drop the three-bullet cap: substance (worked examples) at any length, fluff (diff narration, transcripts) banned. Closes #29 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
2 participants
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
The design is the one artifact the human must absorb at a gate, and abstract prose forces reverse-engineering the change from the diff later.
templates/design.mdmandated an example only for style-unification designs, and its "~1 page, no code blocks" cap actively pushed examples out.What changed
templates/design.md: every design's "How it will work" must carry worked examples — concrete before→after instances of the primary artifact, one per consequence-carrying decision, each stating its consequence. Cap reworded to "~1 page of prose plus worked examples; no implementation code". A meta-example shows the form.SKILL.md: design presentations lead with a "What changes at a glance" before→after block; the full paste still follows. PR bodies drop the three-bullet cap — worked examples welcome at any length, diff narration and transcripts stay banned. Hard rule "Keep design short" → "Keep design focused".Exemplar for the example style: apify/apify-mcp-server#1279.
Closes #29
🤖 Generated with Claude Code