Add .preflight/ config example directory#174
Conversation
- examples/.preflight/config.yml — main config with inline docs - examples/.preflight/triage.yml — triage rules with keyword examples - examples/.preflight/contracts/api.yml — sample contract definitions - examples/.preflight/README.md — getting started guide - README.md — link to examples from config section
The README references 'copy examples/.preflight/ into your project' but the directory didn't exist. Added: - config.yml with annotated settings - triage.yml with classification rules - contracts/api.yml with sample contract definitions - README.md explaining how to use them
|
This is a great DX addition — the annotated examples make onboarding way easier. One suggestion: add a note in the contracts README that the |
TerminalGravity
left a comment
TerminalGravity
left a comment
There was a problem hiding this comment.
Nice addition — having a concrete example config to cp -r lowers the onboarding bar significantly. The annotations in the YAML files are clear and the contract example is realistic enough to be useful without being overwhelming. Ship it.
TerminalGravity
left a comment
TerminalGravity
left a comment
There was a problem hiding this comment.
TerminalGravity
left a comment
TerminalGravity
left a comment
There was a problem hiding this comment.
Config example directory is a nice onboarding touch. Pairs well with #177's troubleshooting guide. LGTM.
|
Closing in favor of #190. |
1 participant
Adds a ready-to-copy example
.preflight/directory underexamples/with:Also adds a callout in the main README linking to the examples.
The README mentions
.preflight/config extensively but there was no concrete example to copy. This makes onboarding easier — users cancp -r examples/.preflight .preflightand customize.