docs: add example .preflight/ config directory#196
Closed
TerminalGravity wants to merge 1 commit intomainfrom
Closed
docs: add example .preflight/ config directory#196TerminalGravity wants to merge 1 commit intomainfrom
TerminalGravity wants to merge 1 commit intomainfrom
Conversation
…lates The README documents .preflight/ config extensively but there were no actual example files to copy. Adds: - examples/.preflight/config.yml — profile, related projects, thresholds - examples/.preflight/triage.yml — keyword rules and strictness - examples/.preflight/contracts/api.yml — manual contract definitions - examples/.preflight/README.md — setup instructions and tips - README.md pointer to the examples directory
TerminalGravity
commented
Mar 10, 2026
Collaborator
Author
TerminalGravity
left a comment
TerminalGravity
left a comment
There was a problem hiding this comment.
Nice — example configs are exactly what people need to get started without reading the whole README. The triage.yml and contracts examples lower the barrier significantly.
One suggestion: in config.yml, the related_projects paths use /Users/you/projects/... which is fine as a placeholder, but maybe add a comment like # Use absolute paths or paths relative to this project to clarify. People might wonder if relative paths work.
LGTM, ship it.
Collaborator
Author
|
Closing — #201 covers the same examples directory. Let's use that one. |
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 documents
.preflight/config extensively but there were no actual example files users could copy into their projects.Adds
examples/.preflight/with ready-to-use templates:config.yml— profile, related projects, thresholds, embedding providertriage.yml— keyword rules and strictness for prompt classificationcontracts/api.yml— manual type/interface definitionsREADME.md— setup instructions and tipsAlso adds a pointer in the main README linking to the examples.