Add .preflight/ example config directory - #26
Closed
TerminalGravity wants to merge 1 commit into
Closed
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.
TerminalGravity
commented
Feb 27, 2026
TerminalGravity
left a comment
TerminalGravity
left a comment
Collaborator
Author
There was a problem hiding this comment.
Love the example configs — this is exactly what new users need. The annotated YAML with commented-out options is the right pattern. One thought: might be worth adding a cp command to the main README quickstart section too (not just the config reference). Nice work.
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.
The README references
.preflight/config extensively but there were no concrete example files users could copy. This adds:examples/.preflight/config.yml— annotated main config (profile, related projects, thresholds, embeddings)examples/.preflight/triage.yml— triage rules with domain keyword examplesexamples/.preflight/contracts/api.yml— example manual contract definitionsexamples/.preflight/README.md— explains how to copy and customizeAlso adds a callout in the main README Configuration Reference section pointing to the examples.
Users can now:
cp -r examples/.preflight /path/to/project/and customize from there.