Добавление пользовательских инструкций репозитория для GitHub Copilot

Introduction

Пользовательские инструкции репозитория позволяют предоставить Copilot специфические рекомендации и настройки по GitHubрепозиторию. Чтобы узнать, как настроить пользовательские инструкции в IDE, см. Добавление пользовательских инструкций репозитория для GitHub Copilot в ваш IDE. Для получения дополнительной информации о пользовательских инструкциях см. АВТОТИТРЫ.

Предварительные требования для пользовательских инструкций репозитория

• У вас должен быть пользовательский файл инструкций (см. приведенные ниже инструкции).

• Для Обзор кода Copilot, ваш личный выбор использования пользовательских инструкций должен быть настроен как включённый. Эта функция включена по умолчанию. См. инструкции по включению или отключению пользовательских инструкций репозитория далее в этой статье.

Создание пользовательских инструкций

          Copilot ON GitHub поддерживает три типа пользовательских инструкций репозитория. Для подробностей о том, какие GitHub Copilot функции поддерживают такие инструкции, см. [AUTOTITLE.](/copilot/concepts/prompting/response-customization?tool=webui#support-for-repository-custom-instructions)

• Пользовательские инструкции на уровне репозитория применяются ко всем запросам, сделанным в контексте репозитория.

  Они указаны в copilot-instructions.md файле в .github каталоге репозитория. Дополнительные инструкции см. в статье "Создание пользовательских инструкций на уровне репозитория".

• Пользовательские инструкции , относящиеся к пути, применяются к запросам, сделанным в контексте файлов, которые соответствуют указанному пути.

  Они указываются в одном или нескольких NAME.instructions.md файлах внутри или ниже .github/instructions каталога репозитория. Дополнительные инструкции см. в статье "Создание пользовательских инструкций для конкретного пути".

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

• Инструкции агента используются агентами ИИ.

  Вы можете создать один или несколько AGENTS.md файлов, хранящихся в любом месте репозитория. Когда Copilot работает, приоритет будет иметь ближайший AGENTS.md файл в дереве каталогов. Для получения дополнительной информации смотрите репозиторий agentsmd/agents.md.

  Кроме того, можно использовать один CLAUDE.md или GEMINI.md файл, хранящийся в корневом каталоге репозитория.

Создание пользовательских инструкций на уровне репозитория

Вы можете создать собственный пользовательский файл инструкций с нуля. См. статью "Написание собственного copilot-instructions.md файла". В качестве альтернативы вы можете попросить Copilot облачный агент сделать его для вас.

Запрос Copilot облачный агент на генерацию copilot-instructions.md файла

1. Перейдите на вкладку агентов на github.com/copilot/agents.

   Вы также можете попасть на эту страницу, нажав кнопку рядом с строкой поиска на любой странице GitHub, затем выбрав Agents в боковой панели.

2. В выпадающем меню поля запросов выберите репозиторий, для которого хотите Copilot сгенерировать пользовательские инструкции.

3. Скопируйте следующий запрос и вставьте его в поле подсказки, при необходимости настроив его:

   Markdown

   Your task is to "onboard" this repository to Copilot cloud agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a cloud agent seeing it for the first time can work most efficiently.
   
   You will do this task only one time per repository and doing a good job can SIGNIFICANTLY improve the quality of the agent's work, so take your time, think carefully, and search thoroughly before writing the instructions.
   
   <Goals>
   - Reduce the likelihood of a cloud agent pull request getting rejected by the user due to
   generating code that fails the continuous integration build, fails a validation pipeline, or
   having misbehavior.
   - Minimize bash command and build failures.
   - Allow the agent to complete its task more quickly by minimizing the need for exploration using grep, find, str_replace_editor, and code search tools.
   </Goals>
   
   <Limitations>
   - Instructions must be no longer than 2 pages.
   - Instructions must not be task specific.
   </Limitations>
   
   <WhatToAdd>
   
   Add the following high level details about the codebase to reduce the amount of searching the agent has to do to understand the codebase each time:
   <HighLevelDetails>
   
   - A summary of what the repository does.
   - High level repository information, such as the size of the repo, the type of the project, the languages, frameworks, or target runtimes in use.
   </HighLevelDetails>
   
   Add information about how to build and validate changes so the agent does not need to search and find it each time.
   <BuildInstructions>
   
   - For each of bootstrap, build, test, run, lint, and any other scripted step, document the sequence of steps to take to run it successfully as well as the versions of any runtime or build tools used.
   - Each command should be validated by running it to ensure that it works correctly as well as any preconditions and postconditions.
   - Try cleaning the repo and environment and running commands in different orders and document errors and misbehavior observed as well as any steps used to mitigate the problem.
   - Run the tests and document the order of steps required to run the tests.
   - Make a change to the codebase. Document any unexpected build issues as well as the workarounds.
   - Document environment setup steps that seem optional but that you have validated are actually required.
   - Document the time required for commands that failed due to timing out.
   - When you find a sequence of commands that work for a particular purpose, document them in detail.
   - Use language to indicate when something should always be done. For example: "always run npm install before building".
   - Record any validation steps from documentation.
   </BuildInstructions>
   
   List key facts about the layout and architecture of the codebase to help the agent find where to make changes with minimal searching.
   <ProjectLayout>
   
   - A description of the major architectural elements of the project, including the relative paths to the main project files, the location
   of configuration files for linting, compilation, testing, and preferences.
   - A description of the checks run prior to check in, including any GitHub workflows, continuous integration builds, or other validation pipelines.
   - Document the steps so that the agent can replicate these itself.
   - Any explicit validation steps that the agent can consider to have further confidence in its changes.
   - Dependencies that aren't obvious from the layout or file structure.
   - Finally, fill in any remaining space with detailed lists of the following, in order of priority: the list of files in the repo root, the
   contents of the README, the contents of any key source files, the list of files in the next level down of directories, giving priority to the more structurally important and snippets of code from key source files, such as the one containing the main method.
   </ProjectLayout>
   </WhatToAdd>
   
   <StepsToFollow>
   - Perform a comprehensive inventory of the codebase. Search for and view:
   - README.md, CONTRIBUTING.md, and all other documentation files.
   - Search the codebase for build steps and indications of workarounds like 'HACK', 'TODO', etc.
   - All scripts, particularly those pertaining to build and repo or environment setup.
   - All build and actions pipelines.
   - All project files.
   - All configuration and linting files.
   - For each file:
   - think: are the contents or the existence of the file information that the cloud agent will need to implement, build, test, validate, or demo a code change?
   - If yes:
      - Document the command or information in detail.
      - Explicitly indicate which commands work and which do not and the order in which commands should be run.
      - Document any errors encountered as well as the steps taken to workaround them.
   - Document any other steps or information that the agent can use to reduce time spent exploring or trying and failing to run bash commands.
   - Finally, explicitly instruct the agent to trust the instructions and only perform a search if the information in the instructions is incomplete or found to be in error.
   </StepsToFollow>
      - Document any errors encountered as well as the steps taken to work-around them.
   
   

4. Click or press Enter.

Copilot will start a new session, which will appear in the list below the prompt box. Copilot will create a draft pull request, write your custom instructions, push them to the branch, then add you as a reviewer when finished, triggering a notification.

Writing your own copilot-instructions.md file

1. In the root of your repository, create a file named .github/copilot-instructions.md.

   Create the .github directory if it does not already exist.

2. Add natural language instructions to the file, in Markdown format.

   Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility.

Creating path-specific custom instructions

1. Создайте каталог, .github/instructions если он еще не существует.

2. По желанию создайте подкаталоги .github/instructions для организации ваших файлов инструкций.

3. Создайте один или несколько NAME.instructions.md файлов, где NAME указывается назначение инструкций. Имя файла должно заканчиваться .instructions.md.

4. В начале файла создайте блок frontmatter, содержащий ключевое applyTo слово. Используйте синтаксис glob, чтобы указать, к каким файлам или каталогам применяются инструкции.

   Например:

   ---
   applyTo: "app/models/**/*.rb"
   ---
   

   Можно указать несколько шаблонов, разделив их запятыми. Например, чтобы применить инструкции ко всем файлам TypeScript в репозитории, можно использовать следующий блок frontmatter:

   ---
   applyTo: "**/*.ts,**/*.tsx"
   ---
   

   Примеры Glob:

   • * - все будут совпадать со всеми файлами текущей директории.
   • ** или **/* — все совпадут со всеми файлами во всех каталогах.
   • *.py - будет совпадать со всеми .py файлами текущей папки.
   • **/*.py - будет рекурсивно совпадать со всеми .py файлами во всех каталогах.
   • src/*.py- будет .py совпадать со всеми src файлами в каталоге. Например src/foo.py , и src/bar.pyнетsrc/foo/bar.py.
   • src/**/*.py - будет рекурсивно совпадать со всеми .py файлами в src каталоге. Например, src/foo.py, src/foo/bar.pyи src/foo/bar/baz.py.
   • **/subdir/**/*.py - будет рекурсивно совпадать со всеми .py файлами в любой subdir папке на любой глубине. Например, subdir/foo.py, subdir/nested/bar.py, parent/subdir/baz.py, и deep/parent/subdir/nested/qux.py, но неfoo.py на пути, не содержащем каталога subdir .

5. Опционально, чтобы предотвратить использование файла либо Copilot облачный агент одним из вариантов Обзор кода Copilot, добавьте excludeAgent ключевое слово в блок фронтматтера. Используйте либо или "code-review"``"cloud-agent".

   Например, следующий файл будет читаться только .Copilot облачный агент

   ---
   applyTo: "**"
   excludeAgent: "code-review"
   ---
   

   Если ключевое excludeAgent слово не включено в передний блок Matterblock, оба Обзор кода Copilot и Copilot облачный агент будут использовать ваши инструкции.

6. Добавьте пользовательские инструкции на естественном языке с помощью формата Markdown. Пробелы между инструкциями игнорируются, поэтому инструкции могут быть написаны как один абзац, каждый из которых находится на новой строке или разделен пустыми строками для удобочитаемости.

          <a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline">
          <span>Да</span></a><a href="https://docs.github.io/success-test/no.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline"><span>нет</span></a>

Пользуемые инструкции

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

In Копилот Чат (github.com/copilot), you can start a conversation that uses repository custom instructions by adding, as an attachment, the repository that contains the instructions file.

Whenever repository custom instructions are used by Копилот Чат, the instructions file is added as a reference for the response that's generated. To find out whether repository custom instructions were used, expand the list of references at the top of a chat response in the Chat panel and check whether the .github/copilot-instructions.md file is listed.

You can click the reference to open the file.

Enabling or disabling custom instructions for Обзор кода Copilot

Custom instructions are enabled for Обзор кода Copilot by default but you can disable, or re-enable, them in the repository settings on GitHub.com. This applies to Copilot's use of custom instructions for all code reviews it performs in this repository.

1. На GitHubперейдите на главную страницу репозитория.

2. Под именем репозитория щелкните Settings. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку "Параметры".

   

3. In the "Code & automation" section of the sidebar, click Copilot, then Code review.

4. Toggle the “Use custom instructions when reviewing pull requests” option on or off.

Further reading

• Поддержка различных типов пользовательских инструкций
• Пользовательские инструкции—a curated collection of examples
• Использование пользовательских инструкций для разблокировки возможностей обзора кода Copilot