Improve .preflight/ example configs with clearer comments and practical defaults - #34
Closed
TerminalGravity wants to merge 4 commits into
Closed
Improve .preflight/ example configs with clearer comments and practical defaults#34TerminalGravity wants to merge 4 commits into
TerminalGravity wants to merge 4 commits into
Conversation
… and contracts The README references .preflight/ config extensively but there were no concrete example files to copy. This adds a ready-to-use examples/.preflight/ directory with annotated config.yml, triage.yml, and contracts/api.yml, plus a README explaining how to use them.
Created examples/USAGE_EXAMPLES.md with 8 real-world scenarios showing what each tool looks like in practice: preflight_check catching vague prompts, scope_work creating execution plans, enrich_agent_task for sub-agents, sharpen_followup resolving ambiguity, session health checks, semantic history search, weekly scorecards, and prompt grading. Added link to usage examples in README nav bar.
…al defaults - Use relative paths instead of absolute in related_projects examples - Add more domain-specific always_check examples (billing, auth) - Clearer profile descriptions explaining what each level actually does - Better README with env var fallback table and commit-to-vcs guidance - Add practical skip examples (git status, npm test, type-check)
The README references examples/.preflight/ but the files didn't exist. Added config.yml, triage.yml, and README.md with all options documented and sensible defaults shown.
TerminalGravity
commented
Feb 28, 2026
TerminalGravity
left a comment
TerminalGravity
left a comment
Collaborator
Author
There was a problem hiding this comment.
The example configs are well-annotated — exactly the kind of thing that saves new users 30 minutes of guessing. The contracts example with the User interface is practical without being toy-ish.
One note: PRs #33 and #29 also include these same example config files (looks like they were cherry-picked or rebased together). Might want to land this one as the canonical source and strip the duplicates from the others to avoid merge noise.
LGTM otherwise.
This was referenced Feb 28, 2026
Collaborator
Author
|
Superseded by newer PRs. |
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.
Rewrites the example .preflight/ config files to be more user-friendly:
No code changes — documentation/examples only.