Add examples/.preflight/ config directory - #67
Closed
TerminalGravity wants to merge 1 commit into
Closed
Conversation
…e, and contract files
TerminalGravity
commented
Mar 3, 2026
TerminalGravity
left a comment
TerminalGravity
left a comment
Collaborator
Author
There was a problem hiding this comment.
Great for onboarding — cp -r examples/.preflight/ ./ is exactly what people expect. Annotated configs with all options visible beats hunting through docs. The contracts example is a nice touch. Ready to merge.
Collaborator
Author
|
Closing — 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 documents .preflight/ config but there was no copy-paste-ready example. This adds:
examples/.preflight/config.yml— annotated main config with all optionsexamples/.preflight/triage.yml— triage rules with domain keyword examplesexamples/.preflight/contracts/api.yml— sample manual contract definitionsexamples/.preflight/README.md— explains each file and how to use themUsers can
cp -r examples/.preflight/ /path/to/project/and customize.