GitHub Copilot Instructions Generator

Highlights

Example output

# Repository Custom Instructions

These instructions guide GitHub Copilot for this repository.

## Code Style

- Never use the `any` type in TypeScript. Prefer `unknown` with type narrowing.
- Use named exports for React components, not default exports.

## Testing

- All tests must pass locally before opening a pull request.
- Every new feature or bug fix must include corresponding tests.

## Boundaries

### ⚠️ Ask first

- Ask before adding any new npm dependency.

Frequently asked questions

• Where should the Copilot instructions file live? ▾

  .github/copilot-instructions.md is GitHub's official standard path. Place it in the .github directory at your repository root and GitHub Copilot picks it up automatically when generating suggestions.
• Do I need to enable anything for Copilot to read this file? ▾

  By default it is recognized without extra setup. Some organization policies may disable 'Use Instructions Files', so check that the instructions-file option is enabled in your GitHub Copilot settings if it does not seem to apply.
• How is this different from path-specific .github/instructions/*.instructions.md? ▾

  copilot-instructions.md is the baseline that applies repository-wide. .github/instructions/*.instructions.md files use an applyTo glob pattern in frontmatter to target specific files. ConfigDeck outputs the single-file format in Phase A and will support path-specific splits in Phase B.
• Why a three-tier Boundaries section? ▾

  Splitting boundaries into 'Always do', 'Ask first', and 'Never do' makes Copilot's behavior more consistent than free-form text. The 'Never do' tier is especially effective for security and deployment rules where mistakes are costly.
• Where do I put team-specific rules? ▾

  Anything you type into ConfigDeck's Additional Notes input is appended verbatim to the bottom of the output file. Use it for team conventions, domain terminology, or library usage patterns that the catalog does not cover.