Примечание.
- Примеры, приведенные в этой библиотеке, предназначены для вдохновения— рекомендуется настроить их для более конкретных проектов, языков и командных процессов.
- Примеры пользовательских инструкций для определенных языков и сценариев в сообществе см. в репозитории GitHub Copilot Customs .
- Пользовательские инструкции можно применять в разных областях в зависимости от платформы или интегрированной среды разработки, в которой вы создаете их. Дополнительные сведения см. в разделе «О кастомизации ответов GitHub Copilot».
Сведения о настройках
Вы можете настроить ответы GitHub Copilot, используя два типа файлов:
-
**Пользовательские инструкции предоставляют текущие рекомендации** по работе GitHub Copilot во всех взаимодействиях. -
**Файлы запроса (общедоступная предварительная версия)** определяют повторно используемые запросы для определенных задач, которые можно вызвать при необходимости. Файлы запросов доступны только в IDE VS Code, Visual Studio и JetBrains. Вводный пример см. [в разделе AUTOTITLE.](/copilot/tutorials/customization-library/prompt-files/your-first-prompt-file)
Хотя пользовательские инструкции помогают добавить контекст в каждый рабочий процесс ИИ, файлы запросов позволяют добавлять инструкции в определенное взаимодействие чата.
Пользовательские инструкции репозитория наиболее часто используются и поддерживаются, но также можно определить личные и организационные пользовательские инструкции только для GitHub Copilot Чат в GitHub. Пользовательские инструкции репозитория можно создать двумя способами:
-
**Инструкции** на уровне репозитория: создайте один `copilot-instructions.md` файл в корневом каталоге репозитория, который применяется ко всем файлам в репозитории. -
**Инструкции** для конкретного `.instructions.md` пути: создайте один или несколько `applyTo` файлов с полем, которое применяется только к определенным файлам или каталогам. В настоящее время для { **% данных variables.copilot.copilot_chat_short %}** в Visual Studio Code, Visual Studio и **GitHub Copilot codeding agent**.
Ваши первые инструкции
Начните с этих основных пользовательских инструкций, которые помогают GitHub Copilot понять ваши настройки кодирования.
Инструкции по написанию функций
When writing functions, always: - Add descriptive JSDoc comments - Include input validation - Use early returns for error conditions - Add meaningful variable names - Include at least one example usage in comments
When writing functions, always:
- Add descriptive JSDoc comments
- Include input validation
- Use early returns for error conditions
- Add meaningful variable names
- Include at least one example usage in comments
Эти инструкции изменят способ создания функций GitHub Copilot.
Тестирование
Чтобы быстро проверить разницу от пользовательских инструкций, можно использовать личные инструкции в Копилот Чат.
-
Сначала перейдите в github.com/copilot и введите этот запрос:
Create a JavaScript function that calculates the area of a circle**Без пользовательских инструкций** можно получить:function areaOfCircle(radius) { if (typeof radius !== 'number' || radius < 0) { throw new Error('Radius must be a non-negative number'); } return Math.PI * radius * radius; } -
Теперь access свои индивидуальные инструкции, кликнув на фотографию профиля в левом нижнем углу страницы, затем Personal instructions. Вставьте приведенные выше инструкции в текстовое поле и нажмите кнопку "Сохранить".
Теперь введите тот же запрос, который вы ввели ранее.
**С пользовательскими инструкциями** вы получите примерно следующее:/** * Calculates the area of a circle given its radius. * * @param {number} radius - The radius of the circle. Must be a positive number. * @returns {number|null} The area of the circle, or null if the input is invalid. * * @example * // returns 78.53981633974483 * areaOfCircle(5); * * @example * // returns null (invalid input) * areaOfCircle(-2); */ function areaOfCircle(radius) { if (typeof radius !== "number" || isNaN(radius) || radius <= 0) { // Invalid input: radius must be a positive number return null; } const area = Math.PI * Math.pow(radius, 2); return area; } // Example usage: console.log(areaOfCircle(5)); // 78.53981633974483 console.log(areaOfCircle(-2)); // null
Дополнительные материалы
-
[AUTOTITLE](/copilot/concepts/response-customization) — обзор настройки ответа в GitHub Copilot -
[AUTOTITLE](/copilot/how-tos/configure-custom-instructions) — настройка пользовательских инструкций -
[Удивительные настройки](https://github.com/github/awesome-copilot/blob/main/README.md) GitHub Copilot — репозиторий пользовательских инструкций, внесенных сообществом, и других настроек для определенных языков и сценариев