Skip to content

Add .preflight/ example configs with annotated YAML - #118

Closed
TerminalGravity wants to merge 1 commit into
mainfrom
add/preflight-config-examples
Closed

Add .preflight/ example configs with annotated YAML#118
TerminalGravity wants to merge 1 commit into
mainfrom
add/preflight-config-examples

Conversation

@TerminalGravity

Copy link
Copy Markdown
Collaborator

The README mentions .preflight/ config but there were no example files to copy. This adds:

  • examples/.preflight/config.yml — annotated config with all options explained
  • examples/.preflight/triage.yml — triage rules with inline comments
  • examples/.preflight/README.md — setup instructions and env var fallback docs
  • README link to examples from the Configuration Reference section

Users can now cp -r examples/.preflight /path/to/project/ and customize.

@TerminalGravity

Copy link
Copy Markdown
Collaborator Author

Great addition — annotated example configs make a real difference for onboarding. People can just copy the directory and tweak. Minor suggestion: note the minimum preflight version these configs work with, in case options change across releases.

@TerminalGravity
TerminalGravity force-pushed the add/preflight-config-examples branch from 02dd646 to 44df79a Compare March 6, 2026 22:22
@TerminalGravity

Copy link
Copy Markdown
Collaborator Author

Superseded by a newer PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant