К основному содержанию
правило официальный · GitHub

context-engineering — правило для GitHub Copilot: контекст

Правило для GitHub Copilot: как раскладывать файлы, типы и комментарии, чтобы подсказки попадали в проект, а не в пустоту.

Установить в GitHub Copilot · Вручную: положить файлы Все способы и платформы ↓
.github/instructions/context-engineering.instructions.md
Открыть на GitHub

Что делает context-engineering

Это инструкция для Copilot, а не код. Она задаёт привычки, от которых зависит, сколько контекста агент видит: описательные пути вместо src/utils/m.ts, рядом лежащие компоненты, тесты и типы, явные аннотации типов вместо вывода, именованные константы вместо магических чисел.

Внутри — шесть разделов. Структура проекта, паттерны кода, работа с Copilot, контекстные подсказки, изменения в нескольких файлах и разбор случаев, когда подсказки уходят не туда. Отдельно советуется файл COPILOT.md с архитектурными решениями и ссылки на существующие файлы как образец.

Правило подключается файлом .github/instructions/context-engineering.instructions.md и действует на весь проект через applyTo: **. Полезно там, где автодополнение выдаёт общее вместо конкретного: чаще всего причина в открытых вкладках и позиции курсора, а не в модели.

Какие задачи решает

  • объяснить Copilot границы модуля через index-файлы
  • добиться подсказок по типам вместо догадок
  • разложить компоненты, тесты и хуки в одну папку
  • описать архитектуру в COPILOT.md для агента
  • провести рефакторинг по одному файлу за раз

Примеры запросов агенту

  • Открой файлы авторизации в вкладках и подскажи, что менять в middleware
  • Опиши, какие файлы нужны для правки модели User, эндпоинта и тестов
  • Следуй тому же паттерну, что в src/api/users.ts

Как установить context-engineering

Вручную: положить файлы

.github/instructions/context-engineering.instructions.md

Поле applyTo задаёт, к каким файлам применять

По шагам, с командами для каждой платформы: AGENTS.md и CLAUDE.md: что это, кто читает и какой выбрать

Из того же набора732

Весь набор →
copilot-sdk-csharp Правило задаёт рекомендации для C#-проектов, использующих GitHub Copilot SDK. Оно пригодится при настройке клиента, сессий, событий и потоковых ответов. ★ 40 418звёзд репо convert-jpa-to-spring-data-cosmos Пошаговое правило для Copilot: переводит Spring Boot проект с JPA на Azure Cosmos DB через Spring Data Cosmos. Пригодится, когда миграция уже решена и нужен план. ★ 40 418звёзд репо convert-cassandra-to-spring-data-cosmos Инструкция для миграции проектов на Spring Boot с Apache Cassandra на Azure Cosmos DB через spring-data-cosmos. Применяется к коду, сборкам Maven или Gradle и файлам настроек. ★ 40 418звёзд репо context7 Правило подключает Context7 к задачам, где нужны актуальные API и документация по версиям. Оно помогает проверять внешние источники до написания кода. ★ 40 418звёзд репо containerization-docker-best-practices Задаёт стандарты сборки Docker-образов: изолирует процессы, уменьшает размер с помощью multi-stage сборок и фиксирует неизменяемость контейнеров. ★ 40 418звёзд репо coldfusion-cfm Правило задаёт стандарты для ColdFusion-файлов *.cfm: синтаксис, безопасность запросов и структуру приложения. Оно срабатывает при работе с такими файлами. ★ 40 418звёзд репо coldfusion-cfc Правило задаёт Copilot стандарты кода для ColdFusion-компонентов: CFScript, cfqueryparam, аккуратные геттеры и сеттеры. Пригодится, если в проекте есть файлы .cfc. ★ 40 418звёзд репо codexer Инструкция превращает GitHub Copilot в строгого Python-исследователя: требует изоляции окружений, аннотаций типов, тестов на pytest и ищет документацию через Context 7 MCP. ★ 40 418звёзд репо

Похожие

context-compression muratcankoylan Учит агента сворачивать историю долгой сессии в структурную сводку: что делали, какие файлы правили, какие решения приняли и что дальше. CX Codex +1 459установок context-engineering-collection muratcankoylan Набор техник для проектирования продакшн-агентов: управление контекстом, многоагентные системы, долгоживущие петли. Нужен, если вы строите автономные системы, которые должны работать надёжно. CX Codex +1 4 200установок kg-extract ruvnet Скилл извлекает сущности и связи из исходников, строит граф знаний в AgentDB. Нужен для анализа структуры кодовой базы, зависимостей и оценки влияния изменений. CX Codex +1 730установок cargo-context getcargo Управляет базой знаний GTM в формате markdown через Git. Нужен агенту, чтобы читать и обновлять профили клиентов, возражения и позиционирование. CX Codex +1 9 800установок context-mode-ops mksglu Скилл координирует задачи GitHub и релизы через 10-20 динамических субагентов. Пригодится для триажа issues, ревью PR и синхронизации веток. CX Codex +1 1 700установок konsistent-config vercel-labs Настраивает правила структуры проекта в konsistent.json для кодовой базы на TypeScript. Помогает зафиксировать файловые паттерны, форматы импортов и экспортов. CX Codex +1 2 500установок

Рядом в теме «Настройка агента: память, контекст, субагенты»

Все правила IDE по теме «Настройка агента: память, контекст, субагенты» →

Вопросы о context-engineering

Как установить context-engineering в GitHub Copilot?

Положи файл .github/instructions/context-engineering.instructions.md в репозиторий. Директива applyTo: ** в начале файла включает правило для всего проекта.

Что делает context-engineering?

Описывает, как структурировать код и проект, чтобы Copilot лучше понимал контекст. Пути, типы, имена и комментарии здесь работают как подсказки для модели.

Почему Copilot выдаёт общие ответы?

Правило советует проверить открытые вкладки и позицию курсора: Copilot опирается на них как на сигналы контекста. Если файлы не открыты, добавь ограничения и упомяни фреймворк.

Исходный текст

context-engineering.instructions.md · MIT
---
description: 'Guidelines for structuring code and projects to maximize GitHub Copilot effectiveness through better context management'
applyTo: '**'
---

# Context Engineering

Principles for helping GitHub Copilot understand your codebase and provide better suggestions.

## Project Structure

- **Use descriptive file paths**: `src/auth/middleware.ts` > `src/utils/m.ts`. Copilot uses paths to infer intent.
- **Colocate related code**: Keep components, tests, types, and hooks together. One search pattern should find everything related.
- **Export public APIs from index files**: What's exported is the contract; what's not is internal. This helps Copilot understand boundaries.

## Code Patterns

- **Prefer explicit types over inference**: Type annotations are context. `function getUser(id: string): Promise<User>` tells Copilot more than `function getUser(id)`.
- **Use semantic names**: `activeAdultUsers` > `x`. Self-documenting code is AI-readable code.
- **Define constants**: `MAX_RETRY_ATTEMPTS = 3` > magic number `3`. Named values carry meaning.

## Working with Copilot

- **Keep relevant files open in tabs**: Copilot uses open tabs as context signals. Working on auth? Open auth-related files.
- **Position cursor intentionally**: Copilot prioritizes code near your cursor. Put cursor where context matters.
- **Use Copilot Chat for complex tasks**: Inline completions have minimal context. Chat mode sees more files.

## Context Hints

- **Add a COPILOT.md file**: Document architecture decisions, patterns, and conventions Copilot should follow.
- **Use strategic comments**: At the top of complex modules, briefly describe the flow or purpose.
- **Reference patterns explicitly**: "Follow the same pattern as `src/api/users.ts`" gives Copilot a concrete example.

## Multi-File Changes

- **Describe scope first**: Tell Copilot all files involved before asking for changes. "I need to update the User model, API endpoint, and tests."
- **Work incrementally**: One file at a time, verifying each change. Don't ask for everything at once.
- **Check understanding**: Ask "What files would you need to see?" before complex refactors.

## When Copilot Struggles

- **Missing context**: Open the relevant files in tabs, or explicitly paste code snippets.
- **Stale suggestions**: Copilot may not see recent changes. Re-open files or restart the session.
- **Generic answers**: Be more specific. Add constraints, mention frameworks, reference existing code.

© github · MIT · github/awesome-copilot

Смотрите также

Спонсоры проекта

Компании, которые помогают держать аналитику открытой