GitHub Copilot Instructions Rules

ai-toolscopilotconventions

Best practices for writing .github/copilot-instructions.md files that give GitHub Copilot accurate project context for consistent, high-quality code suggestions.

Целевые файлы

Файл	Формат
.cursorrules	plaintext
CLAUDE.md	markdown

Содержимое

# GitHub Copilot Instructions Rules ## File Placement & Scope - Store Copilot instructions at `.github/copilot-instructions.md`. This file is automatically picked up by Copilot in VS Code and Copilot Chat. - For monorepos, you may add workspace-specific instructions, but `.github/copilot-instructions.md` at root applies globally. - Commit this file to version control so all team members benefit from the same context. ## Content Structure - Open with a concise project description (2-4 sentences): domain, tech stack, key constraints. - Use H2 headers for logical sections. Suggested sections: - `## Project Overview` - `## Tech Stack` - `## Code Style` - `## Naming Conventions` - `## Architecture Patterns` - `## Testing` - `## Do Not` ## Specificity - Copilot works best with concrete examples in the instructions. - Show preferred patterns inline: "Use `Result<T, E>` instead of throwing: `return Ok(value)` / `return Err(error)`." - Specify complete import paths for common utilities: "Import logger from `@/lib/logger`, not console." - List file naming rules with examples: `user-profile.tsx`, `useUserProfile.ts`, `UserProfile.test.tsx`. ## Language & Framework Versions - State the language version explicitly: "TypeScript 5.4 with strict mode enabled." - State major framework versions where API differs: "React 19 — use `use()` hook, not `useEffect` for data fetching." - Note deprecated APIs to avoid in this project: "Do not use Pages Router — use App Router only." ## Style Guidelines - Specify formatter and linter: "Prettier (2-space indent, single quotes, no semicolons). ESLint with project config." - State preference for functional vs OO style where relevant. - Specify async patterns: `async/await` preferred over `.then()` chains; never mix both in the same function. ## Naming Conventions - Be exhaustive: cover files, folders, variables, functions, types/interfaces, constants, database fields, environment variables, CSS classes. - Note prefixes/suffixes: React hooks always `use*`, higher-order components always `with*`, context providers always `*Provider`. ## Architecture Decisions - Document the layer boundaries that must be respected. - Specify how dependencies flow: "Services may not import from route handlers. Route handlers import from services." - Note which global state management is used and when to reach for it vs local state. ## Testing Guidelines - Specify test framework and runner. Note co-location policy. - Describe what must be unit-tested vs integration-tested. - Note test data conventions: factory functions, fixtures, or inline data. ## Security Rules - "Never hardcode credentials, API keys, or secrets — use environment variables." - "Always validate and sanitize user input at the API boundary." - "Use parameterized queries. Never concatenate user input into SQL." ## Maintenance - Review and update instructions whenever stack versions change or new conventions are adopted. - Keep instructions under 300 lines — Copilot's context window is finite. - Remove outdated rules promptly. Conflicting instructions confuse the model.

CLI

npx mindaxis apply copilot-instructions-rules --target cursor --scope project

Используется в паках

AI Prompting Toolkit

Master Claude, Codex, and LLM prompt engineering

Открыть пак →

Cursor Pro Workflow

Supercharge Cursor IDE with AI-assisted coding patterns

Открыть пак →

← Правила

GitHub Copilot Instructions Rules

ai-toolscopilotconventions

Best practices for writing .github/copilot-instructions.md files that give GitHub Copilot accurate project context for consistent, high-quality code suggestions.

Целевые файлы

Файл	Формат
.cursorrules	plaintext
CLAUDE.md	markdown

Содержимое

CLI

npx mindaxis apply copilot-instructions-rules --target cursor --scope project

Используется в паках

AI Prompting Toolkit

Master Claude, Codex, and LLM prompt engineering

Открыть пак →

Cursor Pro Workflow

Supercharge Cursor IDE with AI-assisted coding patterns

Открыть пак →