diff --git a/CHANGELOG.md b/CHANGELOG.md index 44aebc91fdec..eb4bf8f8b096 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Docs changelog +**17 October 2025** + +We have updated the [Account and profile](https://docs.github.com/en/account-and-profile) and [Subscriptions and notifications](https://docs.github.com/en/subscriptions-and-notifications) docs for improved usability, scannability, and information architecture. + +To support accomplishing tasks without context switching or sifting through unrelated content, articles are now organized by content type and focused on jobs-to-be-done. Additionally, related information is now linked from content type to content type. + +
+ **14 October 2025** We've added a new tutorial about how to [Review AI-generated code](https://docs.github.com/en/copilot/tutorials/review-ai-generated-code). The article gives techniques to verify and validate AI-generated code, and also suggests how Copilot can help with reviews. diff --git a/content/copilot/concepts/prompting/response-customization.md b/content/copilot/concepts/prompting/response-customization.md index cf3b4939d783..aeb9a9b2b047 100644 --- a/content/copilot/concepts/prompting/response-customization.md +++ b/content/copilot/concepts/prompting/response-customization.md @@ -1,5 +1,5 @@ --- -title: About customizing GitHub Copilot Chat responses +title: About customizing GitHub Copilot responses shortTitle: Response customization intro: Learn about customizing the behavior of {% data variables.product.prodname_copilot %} to fit with your preferences and requirements. versions: @@ -47,21 +47,21 @@ contentType: concepts > [!NOTE] This version of this article is about custom instructions in Eclipse. Click the tabs above for other environments. {% endeclipse %} -## About customizing {% data variables.copilot.copilot_chat %} responses +## About customizing {% data variables.product.prodname_copilot_short %} responses {% webui %} -{% data variables.product.prodname_copilot %} can provide chat responses that are tailored to your personal preferences, the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your chat questions, you can create custom instructions that automatically add this information for you. The additional information is not displayed in the chat, but is available to {% data variables.product.prodname_copilot_short %} to allow it to generate higher quality responses. +{% data variables.product.prodname_copilot %} can provide responses that are tailored to your personal preferences, the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your prompts, you can create custom instructions that automatically add this information for you. The additional information is not displayed, but is available to {% data variables.product.prodname_copilot_short %} to allow it to generate higher quality responses. ### Types of custom instructions -* **Personal custom instructions** apply to all conversations you have with {% data variables.copilot.copilot_chat_short %} across the {% data variables.product.github %} website. They allow you to specify your individual preferences, such as preferred language or response style, ensuring that the responses are tailored to your personal needs. +* **Personal custom instructions** apply to all conversations you have with {% data variables.product.prodname_copilot_short %} across the {% data variables.product.github %} website. They allow you to specify your individual preferences, such as preferred language or response style, ensuring that the responses are tailored to your personal needs. * **Repository custom instructions** apply to conversations within the context of a specific repository. They are useful for defining project-specific coding standards, frameworks, or tools. For example, you can specify that a repository uses TypeScript and a particular library, ensuring consistent responses for all contributors. * **Organization custom instructions (public preview)** apply to conversations within the context of an organization on the {% data variables.product.github %} website. They are ideal for enforcing organization-wide preferences, such as a common language or security guidelines. Organization custom instructions can only be set by organization owners for organizations with a {% data variables.copilot.copilot_enterprise_short %} subscription. ### About repository custom instructions -You can create two types of repository custom instructions for {% data variables.copilot.copilot_chat_short %} on {% data variables.product.prodname_dotcom_the_website %}: +You can create two types of repository custom instructions for {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %}: {% data reusables.copilot.custom-instructions-about %} @@ -69,9 +69,9 @@ You can create two types of repository custom instructions for {% data variables {% vscode %} -{% data variables.product.prodname_copilot %} can provide chat responses that are tailored to the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your chat questions, you can create files in your repository that automatically add this information for you. +{% data variables.product.prodname_copilot %} can provide responses that are tailored to the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your prompts, you can create files in your repository that automatically add this information for you. -There are two types of files you can use to provide context and instructions to {% data variables.copilot.copilot_chat %} in {% data variables.product.prodname_vscode_shortname %}: +There are two types of files you can use to provide context and instructions to {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_vscode_shortname %}: * **Repository custom instructions** allow you to specify instructions and preferences that {% data variables.product.prodname_copilot_short %} will consider when working in the context of the repository. * **Prompt files** (public preview) allow you to save common prompt instructions and relevant context in Markdown files (`*.prompt.md`) that you can then reuse in your chat prompts. {% data reusables.copilot.prompt-files-available-in-editors %} @@ -82,15 +82,15 @@ While custom instructions help to add codebase-wide context to each AI workflow, {% visualstudio %} -{% data variables.product.prodname_copilot %} can provide chat responses that are tailored to the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your chat questions, you can create a custom instructions file in your repository that automatically adds this information for you. The additional information is not displayed in the chat, but is available to {% data variables.product.prodname_copilot_short %} to allow it to generate higher quality responses. +{% data variables.product.prodname_copilot %} can provide responses that are tailored to the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your prompts, you can create a custom instructions file in your repository that automatically adds this information for you. The additional information is not displayed in the chat input box, but is available to {% data variables.product.prodname_copilot_short %} to allow it to generate higher quality responses. {% endvisualstudio %} {% jetbrains %} -{% data variables.product.prodname_copilot %} can provide chat responses that are tailored to the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your chat questions, you can create a custom instructions file in your repository that automatically adds this information for you. +{% data variables.product.prodname_copilot %} can provide responses that are tailored to the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your prompts, you can create a custom instructions file in your repository that automatically adds this information for you. -There are two types of files you can use to provide context and instructions to {% data variables.copilot.copilot_chat %} in JetBrains IDEs: +There are two types of files you can use to provide context and instructions to {% data variables.product.prodname_copilot_short %} in JetBrains IDEs: * **Repository custom instructions** allow you to specify instructions and preferences that {% data variables.product.prodname_copilot_short %} will consider when working in the context of the repository. * **Prompt files** (public preview) allow you to save common prompt instructions and relevant context in Markdown files (`*.prompt.md`) that you can then reuse in your chat prompts. {% data reusables.copilot.prompt-files-available-in-editors %} @@ -101,15 +101,15 @@ While custom instructions help to add codebase-wide context to each AI workflow, {% xcode %} -{% data variables.product.prodname_copilot %} can provide chat responses that are tailored to the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your chat questions, you can create a custom instructions file in your repository that automatically adds this information for you. The additional information is not displayed in the chat, but is available to {% data variables.product.prodname_copilot_short %} to allow it to generate higher quality responses. +{% data variables.product.prodname_copilot %} can provide responses that are tailored to the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your prompts, you can create a custom instructions file in your repository that automatically adds this information for you. The additional information is not displayed in the chat input box, but is available to {% data variables.product.prodname_copilot_short %} to allow it to generate higher quality responses. {% endxcode %} {% eclipse %} -{% data variables.product.prodname_copilot %} can provide chat responses that are tailored to the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your chat questions, you can create a custom instructions file in your repository that automatically adds this information for you. The additional information is not displayed in the chat, but is available to {% data variables.product.prodname_copilot_short %} to allow it to generate higher quality responses. +{% data variables.product.prodname_copilot %} can provide responses that are tailored to the way your team works, the tools you use, or the specifics of your project, if you provide it with enough context to do so. Instead of repeatedly adding this contextual detail to your prompts, you can create a custom instructions file in your repository that automatically adds this information for you. The additional information is not displayed in the chat input box, but is available to {% data variables.product.prodname_copilot_short %} to allow it to generate higher quality responses. -There are two types of repository custom instructions you can use to provide context and instructions to {% data variables.copilot.copilot_chat_short %} in Eclipse: +There are two types of repository custom instructions you can use to provide context and instructions to {% data variables.product.prodname_copilot_short %} in Eclipse: * **Workspace custom instructions** which apply to all projects in a workspace, and allow you to specify workspace-wide instructions and preferences, in a single file. * **Project custom instructions** which apply to a specific project. @@ -204,7 +204,7 @@ The following examples demonstrate how to use prompt files. ## About repository custom instructions -Repository custom instructions consist of a single file, `.github/copilot-instructions.md`, that you create in a repository. The instructions you add to the file should be short, self-contained statements that add context or relevant information to supplement chat questions. +Repository custom instructions consist of a single file, `.github/copilot-instructions.md`, that you create in a repository. The instructions you add to the file should be short, self-contained statements that add context or relevant information to supplement a {% data variables.product.prodname_copilot_short %} prompt. Common use cases include: @@ -216,7 +216,7 @@ Common use cases include: {% data reusables.copilot.repository-custom-instructions-example %} -{% data reusables.copilot.repository-cust-instr-code-review %} +For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions). {% endvisualstudio %} @@ -224,7 +224,7 @@ Common use cases include: ## About repository custom instructions -Repository custom instructions consist of a single file, `.github/copilot-instructions.md`, that you create in a repository. The instructions you add to the file should be short, self-contained statements that add context or relevant information to supplement chat questions. +Repository custom instructions consist of a single file, `.github/copilot-instructions.md`, that you create in a repository. The instructions you add to the file should be short, self-contained statements that add context or relevant information to supplement a {% data variables.product.prodname_copilot_short %} prompt. Common use cases include: @@ -236,6 +236,8 @@ Common use cases include: {% data reusables.copilot.repository-custom-instructions-example %} +For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions). + ## About prompt files > [!NOTE] Prompt files are {% data variables.release-phases.public_preview %} and subject to change. @@ -291,7 +293,7 @@ The following examples demonstrate how to use prompt files. ## About repository custom instructions -Repository custom instructions consist of a single file, `.github/copilot-instructions.md`, that you create in a repository. The instructions you add to the file should be short, self-contained statements that add context or relevant information to supplement chat questions. +Repository custom instructions consist of a single file, `.github/copilot-instructions.md`, that you create in a repository. The instructions you add to the file should be short, self-contained statements that add context or relevant information to supplement a {% data variables.product.prodname_copilot_short %} prompt. Common use cases include: @@ -309,9 +311,9 @@ Common use cases include: ## About repository custom instructions -**Workspace custom instructions** apply to all projects in a workspace, and allow you to specify workspace-wide instructions and preferences. You can use workspace custom instructions to provide context and instructions to {% data variables.copilot.copilot_chat_short %} in Eclipse. +**Workspace custom instructions** apply to all projects in a workspace, and allow you to specify workspace-wide instructions and preferences. You can use workspace custom instructions to provide context and instructions to {% data variables.product.prodname_copilot_short %} in Eclipse. -**Project custom instructions** consist of a single file, `.github/copilot-instructions.md`, that you create in a project. The instructions you add to the file should be short, self-contained statements that add context or relevant information to supplement chat questions. +**Project custom instructions** consist of a single file, `.github/copilot-instructions.md`, that you create in a project. The instructions you add to the file should be short, self-contained statements that add context or relevant information to supplement a {% data variables.product.prodname_copilot_short %} prompt. Common use cases include: @@ -323,6 +325,8 @@ Common use cases include: {% data reusables.copilot.repository-custom-instructions-example %} +For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions). + {% endeclipse %} ## Writing effective custom instructions @@ -353,7 +357,7 @@ Answer all questions in less than 1000 characters, and words of no more than 12 * [AUTOTITLE](/copilot/customizing-copilot/adding-personal-custom-instructions-for-github-copilot) * [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -* [AUTOTITLE](/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot){% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation{% endif %} +* [AUTOTITLE](/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot) {% endwebui %} diff --git a/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md b/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md index 6550daeefee0..e099a2257eb5 100644 --- a/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md +++ b/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md @@ -545,6 +545,10 @@ You can click the reference to open the file. {% data reusables.copilot.custom-instructions-reference %} +## Further reading + +* [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions)—a curated collection of examples + {% endxcode %} {% webui %} @@ -564,6 +568,10 @@ Your choice persists, for all repositories containing a custom instructions file {% data reusables.copilot.custom-instructions-enabling-for-ccr %} +## Further reading + +* [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions)—a curated collection of examples + {% endwebui %} {% vscode %} @@ -593,6 +601,10 @@ Your choice persists, for all repositories containing a custom instructions file {% data reusables.copilot.custom-instructions-enabling-for-ccr %} +## Further reading + +* [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions)—a curated collection of examples + {% endvisualstudio %} {% vscode %} @@ -633,6 +645,10 @@ To enable prompt files, configure the workspace settings. For more information about prompt files, see [Custom instructions for {% data variables.product.prodname_copilot %} in VS Code](https://code.visualstudio.com/docs/copilot/copilot-customization#_reusable-prompt-files-experimental) in the {% data variables.product.prodname_vscode %} documentation. +## Further reading + +* [AUTOTITLE](/copilot/tutorials/customization-library) + {% endvscode %} {% jetbrains %} @@ -673,4 +689,24 @@ Once prompt files are saved, their instructions will apply to the current worksp 1. Submit the chat prompt. +## Further reading + +* [AUTOTITLE](/copilot/tutorials/customization-library) + {% endjetbrains %} + +{% eclipse %} + +## Further reading + +* [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions)—a curated collection of examples + +{% endeclipse %} + +{% copilotcli %} + +## Further reading + +* [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions)—a curated collection of examples + +{% endcopilotcli %} diff --git a/data/reusables/copilot/custom-instructions-about.md b/data/reusables/copilot/custom-instructions-about.md index b5e9e0ec6592..4ba8518d8b38 100644 --- a/data/reusables/copilot/custom-instructions-about.md +++ b/data/reusables/copilot/custom-instructions-about.md @@ -13,4 +13,4 @@ > [!NOTE] > Currently, path-specific custom instructions files are only used by {% data variables.copilot.copilot_code-review_short %}, {% data variables.copilot.copilot_coding_agent %}, and {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_vscode_shortname %}. -For more information, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions). +For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions). diff --git a/data/reusables/copilot/custom-instructions-chat-precedence.md b/data/reusables/copilot/custom-instructions-chat-precedence.md index d859827a5f64..5fccbb7d86dc 100644 --- a/data/reusables/copilot/custom-instructions-chat-precedence.md +++ b/data/reusables/copilot/custom-instructions-chat-precedence.md @@ -1 +1 @@ -Multiple types of custom instructions can apply to a {% data variables.copilot.copilot_chat_short %} conversation. Personal instructions take the highest priority, followed by repository instructions, with organization instructions prioritized last. However, all sets of relevant instructions are still combined and provided to {% data variables.copilot.copilot_chat_short %}. +Multiple types of custom instructions can apply to a request sent to {% data variables.product.prodname_copilot_short %}. Personal instructions take the highest priority, followed by repository instructions, with organization instructions prioritized last. However, all sets of relevant instructions are still combined and provided to {% data variables.product.prodname_copilot_short %}. diff --git a/data/reusables/copilot/repository-custom-instructions-support.md b/data/reusables/copilot/repository-custom-instructions-support.md index 4ce9b2716280..0150f5853c9c 100644 --- a/data/reusables/copilot/repository-custom-instructions-support.md +++ b/data/reusables/copilot/repository-custom-instructions-support.md @@ -1,6 +1,6 @@ ## About repository custom instructions for {% data variables.product.prodname_copilot_short %} -Repository custom instructions let you provide {% data variables.product.prodname_copilot_short %} with repository-specific guidance and preferences. +Repository custom instructions let you provide {% data variables.product.prodname_copilot_short %} with repository-specific guidance and preferences. For more information, see [AUTOTITLE](/copilot/concepts/prompting/response-customization). ### Support for repository custom instructions