GitHub Copilot Integration

GitHub Copilot supports custom instructions through a .github/copilot-instructions.md file in your repository. Any skill from Skills Playground can be pasted into this file to customize how Copilot generates code for your project.

What Is copilot-instructions.md?

The .github/copilot-instructions.md file is a Markdown file that provides repository-specific context to GitHub Copilot. When present, Copilot reads this file and uses its contents as additional context for code suggestions, chat responses, and inline completions.

This is the Copilot equivalent of .cursorrules for Cursor or CLAUDE.md for Claude Code. The instructions are plain text -- the same content works across all tools.

Quick Setup

1. Browse the Skills Playground directory and find a skill for your project
2. Copy the system prompt text
3. Create the file at .github/copilot-instructions.md in your repository
4. Paste the system prompt and save
5. Commit and push to make it available for your whole team

# Create the file
mkdir -p .github
touch .github/copilot-instructions.md

# Paste your skill's system prompt into the file

File Format and Location

The file must be at .github/copilot-instructions.md -- this exact path. It uses standard Markdown:

# Project: E-commerce API

## Tech Stack
- Node.js 22 with TypeScript 5.5
- Express.js, Prisma ORM, PostgreSQL
- Jest for testing, Zod for validation

## Conventions
- Named exports only, no default exports
- All API responses follow: { data, error, meta }
- Use dependency injection for services
- Prefer composition over inheritance

## Testing
- Integration tests for all API endpoints
- Use test database, never mock the ORM
- Test files colocated: feature.ts -> feature.test.ts

## Avoid
- No `any` type -- use `unknown` and narrow
- No raw SQL -- use Prisma query builder
- Don't catch errors silently

What It Affects

Copilot instructions influence:

• Copilot Chat -- Responses in the chat panel follow your conventions
• Inline suggestions -- Code completions align with your patterns
• Copilot Edits -- Multi-file edits follow your architecture
• Code review -- Copilot's review comments reflect your standards

The instructions are loaded automatically. You do not need to reference the file in your prompts.

Organization-Level Instructions

GitHub also supports organization-level Copilot instructions. Admins can set default instructions that apply to all repositories in the organization via Organization Settings > Copilot > Custom Instructions. Repository-level instructions supplement (not replace) organization-level ones.

Tips

• Use Markdown headings. Structure your instructions with ## headings for clarity.
• Be specific. "Use Tailwind CSS utility classes, avoid custom CSS files" works better than "style things well."
• Keep it focused. Copilot loads the entire file into context. Aim for under 500 lines of high-impact instructions.
• Sync across tools. If your team uses multiple AI tools, keep .github/copilot-instructions.md, .cursorrules, and CLAUDE.md in sync with the same content.

For the full guide, see our Copilot Instructions Guide. Browse the skills directory to find skills for your project.