Add .preflight/ example config directory - #98
Closed
TerminalGravity wants to merge 1 commit into
Closed
Conversation
The README documents .preflight/ config extensively but no example files existed in the repo. Added: - .preflight/config.yml — main config with all options commented - .preflight/triage.yml — triage rules with domain examples - .preflight/contracts/example-api.yml — sample manual contracts - .preflight/README.md — quick setup guide Also added a callout in the main README pointing to the examples.
Collaborator
Author
|
Closing — superseded by #118 with more comprehensive example configs. |
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 no example files existed in the repo. New users had to manually piece together config from the docs.
Added:
.preflight/config.yml— main config with all options commented and explained.preflight/triage.yml— triage rules with domain-specific examples.preflight/contracts/example-api.yml— sample manual contract definitions.preflight/README.md— quick setup guideAlso added a callout in the main README Configuration Reference section pointing users to the example configs.
Users can now
cp -r .preflight/ /path/to/their/project/and customize.