Repository navigation
feat: plain-English output for everything a person reads - #119
Merged
Merged
Conversation
…115) New PLAIN-OUTPUT convention: one plain first sentence, terms explained, numbers given meaning, a closing 'You need to decide' line. reader: plain|technical in PREFERENCES.md (default plain), asked once by discuss. Applied to verify, review, build, debt and map completion messages and report tops. Co-Authored-By: Claude Opus 5.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.
Closes #115.
In plain words
SwiftShip's reports and finish messages were written for experts. Now they open with one everyday sentence saying what happened and whether you need to do anything. Technical words get explained, and every message ends by saying what (if anything) you need to decide. The checks and evidence are unchanged; only the wording is different.
What changed
templates/_conventions/PLAIN-OUTPUT.md. It covers:reader: plain | technicalline in PREFERENCES.md. The default is plain./apple:discussasks it once, whatever the phase.verify: an "In plain words" line in VERIFICATION.md (command and template), plus the completion messagereview: an "In plain words" line in REVIEW.md, a "What this means" line for each Critical/High finding (who is affected and how), plus the completion messagebuild: a plain line for each finished task and for the end of the phasedebt: the completion message and DEBT.md's top linemap: the completion message and CODEBASE.md's top lineTested
./scripts/validate.shpasses, andclaude plugin validate .passes.verifyordebtrun will show it.🤖 Generated with Claude Code