diff --git a/assets/images/help/copilot/coding-agent/comment-to-agent-on-pr.png b/assets/images/help/copilot/coding-agent/comment-to-agent-on-pr.png index 78918551e7ad..5759875e849e 100644 Binary files a/assets/images/help/copilot/coding-agent/comment-to-agent-on-pr.png and b/assets/images/help/copilot/coding-agent/comment-to-agent-on-pr.png differ diff --git a/content/billing/managing-billing-for-your-products/managing-billing-for-github-copilot/about-billing-for-github-copilot.md b/content/billing/managing-billing-for-your-products/managing-billing-for-github-copilot/about-billing-for-github-copilot.md index a14941c46177..100cbcd47a3f 100644 --- a/content/billing/managing-billing-for-your-products/managing-billing-for-github-copilot/about-billing-for-github-copilot.md +++ b/content/billing/managing-billing-for-your-products/managing-billing-for-github-copilot/about-billing-for-github-copilot.md @@ -67,7 +67,7 @@ When {% data variables.product.prodname_copilot_short %} works on coding tasks, When you use {% data variables.copilot.copilot_coding_agent %}, {% data variables.product.prodname_copilot_short %} may make multiple premium requests to complete a single task. This includes both user-initiated prompts and follow-up actions {% data variables.product.prodname_copilot_short %} takes on your behalf. The total premium requests used will depend on the complexity of the task and the number of steps involved. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/monitoring-usage-and-entitlements/avoiding-unexpected-copilot-costs). -For more information about {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot). +For more information about {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot). ### What happens if you have used up your monthly quota? diff --git a/content/billing/managing-your-billing/managing-your-payment-and-billing-information.md b/content/billing/managing-your-billing/managing-your-payment-and-billing-information.md index 704b84e12e03..887b1c5e0cb1 100644 --- a/content/billing/managing-your-billing/managing-your-payment-and-billing-information.md +++ b/content/billing/managing-your-billing/managing-your-payment-and-billing-information.md @@ -90,7 +90,7 @@ You can view and edit your billing information and update your payment method. You can view and edit your billing information, update your payment method, and view active coupons. ->[!NOTE] This only applies to invoiced enterprise accounts. +>[!NOTE] This does not apply to invoiced enterprise accounts. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.billing.enterprise-billing-menu %} diff --git a/content/contributing/style-guide-and-content-model/style-guide.md b/content/contributing/style-guide-and-content-model/style-guide.md index 9742cea8eaf5..8e7586a69941 100644 --- a/content/contributing/style-guide-and-content-model/style-guide.md +++ b/content/contributing/style-guide-and-content-model/style-guide.md @@ -869,6 +869,12 @@ Do not capitalize commonly used features like pull requests, topics, or issues. This section describes additional conventions that are specific to GitHub products. +### {% data variables.product.prodname_copilot %} + +#### {% data variables.product.prodname_copilot_short %} code completion + +The {% data variables.product.prodname_copilot_short %} feature that suggests code as you are working on a file is called "{% data variables.product.prodname_copilot_short %} code completion" or just "code completion" (singular). Only use "code suggestions" (plural) when referring to multiple instances of code completion suggestions. For example, "When using {% data variables.product.prodname_copilot_short %} code completion..." but "the plan includes 2,000 code completions..." + ### {% data variables.product.prodname_actions %} #### Reusables for first-party actions diff --git a/content/copilot/about-github-copilot/github-copilot-features.md b/content/copilot/about-github-copilot/github-copilot-features.md index a4fad50678ca..7157d6de64ff 100644 --- a/content/copilot/about-github-copilot/github-copilot-features.md +++ b/content/copilot/about-github-copilot/github-copilot-features.md @@ -24,6 +24,10 @@ If you use {% data variables.product.prodname_vscode_shortname %}, you can also A chat interface that lets you ask coding-related questions. {% data variables.product.prodname_copilot_chat %} is available on the {% data variables.product.github %} website, in {% data variables.product.prodname_mobile %}, in supported IDEs _({% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDEs, Eclipse IDE, and Xcode)_, and in {% data variables.product.prodname_windows_terminal %}. Users can also use skills with {% data variables.product.prodname_copilot_chat_short %}. See [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-github) and [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide). +### {% data variables.copilot.copilot_coding_agent %} ({% data variables.release-phases.public_preview %}) + +An autonomous AI agent that can make code changes for you. You can assign a {% data variables.product.github %} issue to {% data variables.product.prodname_copilot_short %} and the agent will work on making the required changes, and will create a pull request for you to review. You can also ask {% data variables.product.prodname_copilot_short %} to create a pull request from {% data variables.product.prodname_copilot_chat_short %}. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent). + ### {% data variables.product.prodname_copilot_cli_short %} A chat-like interface in the terminal, where you can ask questions about the command line. You can ask {% data variables.product.prodname_copilot_short %} to provide command suggestions or explanations of commands. Users can also integrate {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_windows_terminal %} Canary. See [AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-in-the-command-line). diff --git a/content/copilot/about-github-copilot/plans-for-github-copilot.md b/content/copilot/about-github-copilot/plans-for-github-copilot.md index 7ac544356a01..d36bf3a42e83 100644 --- a/content/copilot/about-github-copilot/plans-for-github-copilot.md +++ b/content/copilot/about-github-copilot/plans-for-github-copilot.md @@ -20,11 +20,11 @@ redirect_from: * **{% data variables.product.prodname_copilot_pro %}** is designed for individuals who want more flexibility. This paid plan includes unlimited completions, access to premium models in {% data variables.product.prodname_copilot_chat_short %}, and a monthly allowance of premium requests. Verified students, teachers, and maintainers of popular open source projects may be eligible for free access. -* **{% data variables.product.prodname_copilot_pro_plus %}** offers the highest level of access for individual developers. In addition to everything in {% data variables.product.prodname_copilot_pro_short %}, this plan includes a larger allowance of premium requests and full access to all available models in {% data variables.product.prodname_copilot_chat_short %}. Ideal for AI power users who want access to the most advanced capabilities. +* **{% data variables.product.prodname_copilot_pro_plus %}** offers the highest level of access for individual developers. In addition to everything in {% data variables.product.prodname_copilot_pro_short %}, this plan includes {% data variables.copilot.copilot_coding_agent %}, a larger allowance of premium requests, and full access to all available models in {% data variables.product.prodname_copilot_chat_short %}. Ideal for AI power users who want access to the most advanced capabilities. * **{% data variables.product.prodname_copilot_for_business %}** is for organizations on {% data variables.product.prodname_free_team %} or {% data variables.product.prodname_team %} plan, or enterprises on {% data variables.product.prodname_ghe_cloud %}. This plan enables centralized management and {% data variables.product.prodname_copilot_short %} policy control for organization members. -* **{% data variables.product.prodname_copilot_enterprise %}** is for enterprises using {% data variables.product.prodname_ghe_cloud %}. It includes all the features of {% data variables.product.prodname_copilot_business_short %}, plus additional enterprise-grade capabilities. Enterprise owners can assign either {% data variables.product.prodname_copilot_enterprise_short %} or {% data variables.product.prodname_copilot_business_short %} to individual organizations. +* **{% data variables.product.prodname_copilot_enterprise %}** is for enterprises using {% data variables.product.prodname_ghe_cloud %}. It includes all the features of {% data variables.product.prodname_copilot_business_short %}, plus {% data variables.copilot.copilot_coding_agent %} and additional enterprise-grade capabilities. Enterprise owners can assign either {% data variables.product.prodname_copilot_enterprise_short %} or {% data variables.product.prodname_copilot_business_short %} to individual organizations. {% data variables.product.prodname_copilot_short %} is not currently available for {% data variables.product.prodname_ghe_server %}. diff --git a/content/copilot/about-github-copilot/what-is-github-copilot.md b/content/copilot/about-github-copilot/what-is-github-copilot.md index b46646e8a3af..35f9e45f2f26 100644 --- a/content/copilot/about-github-copilot/what-is-github-copilot.md +++ b/content/copilot/about-github-copilot/what-is-github-copilot.md @@ -38,6 +38,7 @@ redirect_from: * Ask {% data variables.product.prodname_copilot_short %} for help using the command line * Generate a description of the changes in a pull request _({% data variables.product.prodname_copilot_enterprise_short %} only)_ * Create and manage collections of documentation, called knowledge bases, to use as a context for chatting with {% data variables.product.prodname_copilot_short %} _({% data variables.product.prodname_copilot_enterprise_short %} only)_ +* Work on code changes and create a pull request for you to review _({% data variables.product.prodname_copilot_pro_plus_short %} and {% data variables.product.prodname_copilot_enterprise_short %} only)_ {% data variables.product.prodname_copilot_short %} is available: diff --git a/content/copilot/building-copilot-extensions/copilot-extensions-faq.md b/content/copilot/building-copilot-extensions/copilot-extensions-faq.md index fa528856e210..349e2cafa4bb 100644 --- a/content/copilot/building-copilot-extensions/copilot-extensions-faq.md +++ b/content/copilot/building-copilot-extensions/copilot-extensions-faq.md @@ -32,7 +32,7 @@ For more information, see [AUTOTITLE](/copilot/building-copilot-extensions/about No, {% data variables.product.prodname_copilot_extensions_short %} are not covered by {% data variables.product.prodname_copilot %}’s indemnity policy. However, this exclusion applies only to issues that arise within extension chat threads. -Installing and using extensions does not affect indemnity coverage for any issues that occur while using other {% data variables.product.prodname_copilot_short %} features such as code completions and chat. +Installing and using extensions does not affect indemnity coverage for any issues that occur while using other {% data variables.product.prodname_copilot_short %} features such as code completion and chat. ## Data and Permissions diff --git a/content/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot.md b/content/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot.md index f5b9368eff0f..db07c70e7454 100644 --- a/content/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot.md +++ b/content/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot.md @@ -25,7 +25,7 @@ For an overview of the methods you can use to customize {% data variables.produc {% 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 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. -The custom instructions file is also used by {% data variables.product.prodname_copilot_short %} when you assign it to an issue or ask it to create a pull request. Instructions included in this file can help {% data variables.product.prodname_copilot_short %} to work on files in a way that matches your team's working practices and conforms to coding standards for your project. See [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot). +The custom instructions file is also used by {% data variables.product.prodname_copilot_short %} when you assign it to an issue or ask it to create a pull request. Instructions included in this file can help {% data variables.product.prodname_copilot_short %} to work on files in a way that matches your team's working practices and conforms to coding standards for your project. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot). ### Example diff --git a/content/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent.md b/content/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent.md index 3e68b748ae12..676af2153218 100644 --- a/content/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent.md +++ b/content/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent.md @@ -12,7 +12,7 @@ type: how_to > [!NOTE] > {% data reusables.copilot.coding-agent.preview-note-text %} > -> For more information about {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot). +> For more information about {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot). ## Overview diff --git a/content/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent.md b/content/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent.md index df8c79271e97..f58591064d6b 100644 --- a/content/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent.md +++ b/content/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent.md @@ -14,7 +14,7 @@ redirect_from: > [!NOTE] > {% data reusables.copilot.coding-agent.preview-note-text %} > -> For more information about {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot). +> For more information about {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot). ## About customizing {% data variables.copilot.copilot_coding_agent %}'s development environment diff --git a/content/copilot/customizing-copilot/extending-copilot-coding-agent-with-mcp.md b/content/copilot/customizing-copilot/extending-copilot-coding-agent-with-mcp.md index 9667165fbc33..c70093551847 100644 --- a/content/copilot/customizing-copilot/extending-copilot-coding-agent-with-mcp.md +++ b/content/copilot/customizing-copilot/extending-copilot-coding-agent-with-mcp.md @@ -15,7 +15,7 @@ redirect_from: > [!NOTE] > {% data reusables.copilot.coding-agent.preview-note-text %} > -> For more information about {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot). +> For more information about {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot). {% data reusables.copilot.coding-agent.mcp-brief-intro %} @@ -33,9 +33,9 @@ Once you've configured an MCP server, {% data variables.product.prodname_copilot We recommend that you restrict your servers to read-only tools. You can use the `tools` configuration option to only expose known, safe tools to {% data variables.product.prodname_copilot_short %}. -## Setting up MCP servers in a repository +## About setting up MCP servers in a repository -As a repository administrator, you can configure MCP servers for use within your repository. This is done via JSON configuration that specifies the details of the MCP servers you want to use. +As a repository administrator, you can configure MCP servers for use within your repository. This is done via a JSON-formatted configuration that specifies the details of the MCP servers you want to use. You enter the JSON configuration directly into the settings for the repository on {% data variables.product.prodname_dotcom_the_website %}. Once MCP servers are configured for use within a repository, the tools specified in the configuration will be available to {% data variables.copilot.copilot_coding_agent %} on each assigned task. @@ -43,16 +43,37 @@ Once MCP servers are configured for use within a repository, the tools specified You configure MCP servers using a special JSON format. The JSON must contain an `mcpServers` object, where the key is the name of the MCP server (for example, `playwright`), and the value is an object with the configuration for that MCP server. +```json copy +{ + "mcpServers": { + "MCP SERVER 1": { + "command": "VALUE", + "args": [ VALUES ], + ... + }, + "MCP SERVER 2": { + "command": "VALUE", + "args": [ VALUES ], + ... + }, + ... + } +} +``` + The configuration object can contain the following keys: * `command` (`string`): The command to run to start the MCP server. * `args` (`string[]`): The arguments to pass to the `command`. * `tools` (`string[]`): The tools from the MCP server to enable. You may be able to find a list of tools in the server's documentation, or in its code. We recommend that you allowlist specific tools, but you can also enable all tools by including `*` in the array. +* `type` (`string`): Optional field. {% data variables.copilot.copilot_coding_agent %} only accepts `"local"`. * `env` (`object`): The environment variables to pass to the server. This object should map the name of the environment variable that should be exposed to your MCP server to either of the following: * The name of a {% data variables.product.prodname_actions %} secret you have configured, beginning with `COPILOT_MCP_`. * A string value. -#### Example: Playwright +## Example configurations + +### Example: Playwright The [Playwright MCP server](https://github.com/microsoft/playwright-mcp) provides tools which allow {% data variables.product.prodname_copilot_short %} to browse the internet. @@ -68,7 +89,7 @@ The [Playwright MCP server](https://github.com/microsoft/playwright-mcp) provide } ``` -#### Example: Sentry +### Example: Sentry The [Sentry MCP server](https://github.com/getsentry/sentry-mcp) gives {% data variables.product.prodname_copilot_short %} authenticated access to exceptions recorded in [Sentry](https://sentry.io). @@ -94,7 +115,7 @@ The [Sentry MCP server](https://github.com/getsentry/sentry-mcp) gives {% data v } ``` -#### Example: Notion +### Example: Notion The [Notion MCP server](https://github.com/makenotion/notion-mcp-server) gives {% data variables.product.prodname_copilot_short %} authenticated access to notes and other content from [Notion](https://notion.so). @@ -125,22 +146,75 @@ The [Notion MCP server](https://github.com/makenotion/notion-mcp-server) gives { } ``` -#### Reusing your MCP configuration from {% data variables.product.prodname_vscode %} - -If you have already configured MCP servers in {% data variables.product.prodname_vscode_shortname %}, you can leverage similar configuration for {% data variables.copilot.copilot_coding_agent %}. +### Example: Azure + +The [Azure MCP server](https://github.com/Azure/azure-mcp) creates a seamless connection between {% data variables.product.prodname_copilot_short %} and key Azure services such as Azure Cosmos DB and the Azure Storage platform. + +To use the Azure MCP with {% data variables.copilot.copilot_coding_agent %}, you must update the repository's `copilot-setup-steps.yml` file to include an Azure login workflow step. + +1. Configure OIDC in a Microsoft Entra application, trusting {% data variables.product.github %}. See [Use the Azure Login action with OpenID Connect](https://learn.microsoft.com/en-us/azure/developer/github/connect-from-azure-openid-connect). +1. Add a `.github/workflows/copilot-setup-steps.yml` Actions workflow file in your repository if you do not already have one. +1. Add an Azure login step to the `copilot-setup-steps` workflow job. + + ```yaml copy + on: + workflow_dispatch: + permissions: + id-token: write + contents: read + jobs: + copilot-setup-steps: + runs-on: ubuntu-latest + permissions: + id-token: write + contents: read + environment: Copilot + steps: + - name: Azure login + uses: azure/login@a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0 + with: + client-id: ${{ secrets.AZURE_CLIENT_ID }} + tenant-id: ${{ secrets.AZURE_TENANT_ID }} + subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }} + ``` + + This configuration ensures the `azure/login` action is executed when {% data variables.copilot.copilot_coding_agent %} runs. + +1. In your repository’s {% data variables.product.prodname_copilot_short %} environment, add secrets for your `AZURE_CLIENT_ID`, `AZURE_TENANT_ID` and `AZURE_SUBSCRIPTION_ID`. +1. Configure the Azure MCP server by adding an `azure` object to your MCP configuration. + + ```json copy + { + "mcpServers": { + "Azure MCP Server": { + "command": "npx", + "args": [ + "-y", + "@azure/mcp@latest", + "server", + "start" + ] + } + } + } + ``` + +## Reusing your MCP configuration from {% data variables.product.prodname_vscode %} + +If you have already configured MCP servers in {% data variables.product.prodname_vscode_shortname %}, you can leverage a similar configuration for {% data variables.copilot.copilot_coding_agent %}. Depending on how {% data variables.product.prodname_vscode_shortname %} is configured, you may be able to find your MCP settings in your repository's `.vscode/mcp.json` file, or in your machine's private `settings.json` file. To adapt the configuration for {% data variables.copilot.copilot_coding_agent %}, you will need to: -1. Add a `tools` key for each MCP server, specifying the tools that should be available to {% data variables.product.prodname_copilot_short %}. +1. Add a `tools` key for each MCP server, specifying which tools will be available to {% data variables.product.prodname_copilot_short %}. 1. If you've configured `inputs`, switch to using `env` directly. 1. If you've configured an `envFile`, switch to using `env` directly. 1. Update any references to `inputs` in your `args` configuration to refer to environment variables from `env` instead. For more information on MCP in {% data variables.product.prodname_vscode_shortname %}, see the [{% data variables.product.prodname_vscode_shortname %} docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers). -### Adding your configuration to your repository +## Adding your configuration to your repository Repository administrators can configure MCP servers by following these steps: @@ -168,7 +242,7 @@ You must be a repository administrator to configure a {% data variables.product. 1. Under "Environment secrets", click **Add environment secret**. 1. Give the secret a name beginning `COPILOT_MCP_`, add the secret value, then click **Add secret**. -### Validating your MCP configuration +## Validating your MCP configuration Once you've set up your MCP configuration, you should test it to make sure it is set up correctly. @@ -181,7 +255,7 @@ Once you've set up your MCP configuration, you should test it to make sure it is 1. Click the **Start MCP Servers** step to expand the logs. 1. If your MCP servers have been started successfully, you will see their tools listed at the bottom of the logs. -If your MCP servers require any dependencies that are not installed on the {% data variables.product.prodname_actions %} runner by default, such as `uv` and `pipx`, or that need special setup steps, you may need to create a `copilot-setup-steps.yml` to install them. For more information, see [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent). +If your MCP servers require any dependencies that are not installed on the {% data variables.product.prodname_actions %} runner by default, such as `uv` and `pipx`, or that need special setup steps, you may need to create a `copilot-setup-steps.yml` Actions workflow file to install them. For more information, see [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent). ## Customizing the built-in {% data variables.product.github %} MCP server @@ -202,7 +276,7 @@ If you want to allow {% data variables.product.prodname_copilot_short %} to acce 1. Under "Environment secrets", click **Add environment secret**. 1. Call the secret `COPILOT_MCP_GITHUB_PERSONAL_ACCESS_TOKEN`, enter your {% data variables.product.pat_generic %} in the "Value" field, then click **Add secret**. -## Best practices for using MCP servers in {% data variables.copilot.copilot_coding_agent %} +## Best practices * Enabling third-party MCP servers for use may impact the performance of the agent and the quality of the outputs. Review the third-party MCP server thoroughly and ensure that it meets your organization’s requirements. diff --git a/content/copilot/index.md b/content/copilot/index.md index 5192d01b4234..2f9e36240c84 100644 --- a/content/copilot/index.md +++ b/content/copilot/index.md @@ -1,7 +1,7 @@ --- title: '{% data variables.product.prodname_copilot %} documentation' shortTitle: '{% data variables.product.prodname_copilot %}' -intro: 'You can use {% data variables.product.prodname_copilot %} to get autocomplete-style suggestions from an AI pair programmer as you code.' +intro: 'You can use {% data variables.product.prodname_copilot %} to enhance your productivity and assist as you work on code.' redirect_from: - /github/copilot changelog: @@ -14,8 +14,9 @@ featuredLinks: - /copilot/about-github-copilot/what-is-github-copilot - /copilot/quickstart - /copilot/building-copilot-extensions/quickstart-for-github-copilot-extensions-using-agents + - /copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot popular: - - /copilot/using-github-copilot/best-practices-for-using-github-copilot + - /copilot/about-github-copilot/github-copilot-features - /copilot/copilot-chat-cookbook - /copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot - /copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-your-ide diff --git a/content/copilot/managing-copilot/monitoring-usage-and-entitlements/about-premium-requests.md b/content/copilot/managing-copilot/monitoring-usage-and-entitlements/about-premium-requests.md index 186ae7039c75..153c8b0f06d7 100644 --- a/content/copilot/managing-copilot/monitoring-usage-and-entitlements/about-premium-requests.md +++ b/content/copilot/managing-copilot/monitoring-usage-and-entitlements/about-premium-requests.md @@ -33,7 +33,7 @@ Some {% data variables.product.prodname_copilot_short %} features use more advan The following {% data variables.product.prodname_copilot_short %} features can use premium requests: * [{% data variables.product.prodname_copilot_chat_short %}](/copilot/using-github-copilot/copilot-chat) -* [{% data variables.copilot.copilot_coding_agent %}](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot) [^1] +* [{% data variables.copilot.copilot_coding_agent %}](/copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot) [^1] * [{% data variables.product.prodname_copilot_agent_short %} mode](/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-your-ide#copilot-edits) * [{% data variables.product.prodname_copilot_short %} code review](/copilot/using-github-copilot/code-review/using-copilot-code-review) * [{% data variables.product.prodname_copilot_extensions_short %}](/copilot/building-copilot-extensions/about-building-copilot-extensions) diff --git a/content/copilot/responsible-use-of-github-copilot-features/responsible-use-of-copilot-coding-agent-on-githubcom.md b/content/copilot/responsible-use-of-github-copilot-features/responsible-use-of-copilot-coding-agent-on-githubcom.md index 8252a4ade1f8..29a0ec8918a1 100644 --- a/content/copilot/responsible-use-of-github-copilot-features/responsible-use-of-copilot-coding-agent-on-githubcom.md +++ b/content/copilot/responsible-use-of-github-copilot-features/responsible-use-of-copilot-coding-agent-on-githubcom.md @@ -73,7 +73,7 @@ For more information about limitations, see [Limitations of {% data variables.co ### Customize your experience with additional context -{% data variables.copilot.copilot_coding_agent %} leverages your prompt, comments and the repository’s code as context when generating suggested changes. To enhance Copilot’s performance, consider implementing custom Copilot instructions to help the agent better understand your project and how to build, test and validate its changes. For more information, see the "Add custom instructions to your repository" in [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/best-practices-for-using-copilot-to-work-on-tasks#adding-custom-instructions-to-your-repository). +{% data variables.copilot.copilot_coding_agent %} leverages your prompt, comments and the repository’s code as context when generating suggested changes. To enhance Copilot’s performance, consider implementing custom Copilot instructions to help the agent better understand your project and how to build, test and validate its changes. For more information, see the "Add custom instructions to your repository" in [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks#adding-custom-instructions-to-your-repository). For information about other customizations for {% data variables.copilot.copilot_coding_agent %}, see: diff --git a/content/copilot/rolling-out-github-copilot-at-scale/enabling-developers/using-copilot-coding-agent-in-org.md b/content/copilot/rolling-out-github-copilot-at-scale/enabling-developers/using-copilot-coding-agent-in-org.md index 9f4ae22d6d4e..c8c133330d7b 100644 --- a/content/copilot/rolling-out-github-copilot-at-scale/enabling-developers/using-copilot-coding-agent-in-org.md +++ b/content/copilot/rolling-out-github-copilot-at-scale/enabling-developers/using-copilot-coding-agent-in-org.md @@ -28,7 +28,7 @@ product: '{% data reusables.gated-features.copilot-coding-agent %}' ## How {% data variables.copilot.copilot_coding_agent %} can contribute to your organization -{% data variables.product.prodname_copilot_short %} can help your organization address well-defined and scoped issues, such as increasing test coverage, fixing bugs or flaky tests, or updating config files or documentation. For more on the kinds of issues {% data variables.product.prodname_copilot_short %} works best on, see [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/best-practices-for-using-copilot-to-work-on-tasks). +{% data variables.product.prodname_copilot_short %} can help your organization address well-defined and scoped issues, such as increasing test coverage, fixing bugs or flaky tests, or updating config files or documentation. For more on the kinds of issues {% data variables.product.prodname_copilot_short %} works best on, see [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks). Developers stay in the flow when they ask {% data variables.product.prodname_copilot_short %} to create pull requests directly from {% data variables.product.prodname_copilot_chat_short %} instead of opening issues that may sit in a backlog. @@ -93,7 +93,7 @@ As with any other change to working practices, it's important to run a trial to 1. Choose an isolated or low-risk repository, for example, one that contains documentation or internal tools. You could create a fresh repository to use as a playground, but {% data variables.product.prodname_copilot_short %} needs context to be successful, so you would need to add a lot of context, including team processes, development environment, and common dependencies. 1. Enable {% data variables.copilot.copilot_coding_agent %} in the repository and optionally enable third-party MCP servers for enhanced context sharing. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/adding-copilot-coding-agent-to-organization). 1. Create repository instructions and pre-install any tools required in the development environment {% data variables.product.prodname_copilot_short %} uses. See [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent). -1. Identify a few compelling use cases for your organization, for example: test coverage or improving accessibility. See [Choose the right type of tasks to give to Copilot](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/best-practices-for-using-copilot-to-work-on-tasks#choosing-the-right-type-of-tasks-to-give-to-copilot) in the best practice guide. +1. Identify a few compelling use cases for your organization, for example: test coverage or improving accessibility. See [Choose the right type of tasks to give to Copilot](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks#choosing-the-right-type-of-tasks-to-give-to-copilot) in the best practice guide. 1. Use best practice to create or refine issues for {% data variables.product.prodname_copilot_short %} in your pilot repository. 1. Assign issues to {% data variables.product.prodname_copilot_short %} and prepare team members to review its work. 1. Spend time looking at the codebase or documentation in {% data variables.product.prodname_vscode_shortname %} or {% data variables.product.prodname_dotcom_the_website %}, asking {% data variables.product.prodname_copilot_short %} to create a pull request to fix any bugs or small improvements that you identify. diff --git a/content/copilot/using-github-copilot/ai-models/choosing-the-right-ai-model-for-your-task.md b/content/copilot/using-github-copilot/ai-models/choosing-the-right-ai-model-for-your-task.md index 4f4dd08616fa..2f59cb92ddcc 100644 --- a/content/copilot/using-github-copilot/ai-models/choosing-the-right-ai-model-for-your-task.md +++ b/content/copilot/using-github-copilot/ai-models/choosing-the-right-ai-model-for-your-task.md @@ -10,7 +10,7 @@ topics: ## Comparison of AI models for {% data variables.product.prodname_copilot %} -{% data variables.product.prodname_copilot %} supports multiple AI models with different capabilities. The model you choose affects the quality and relevance of responses in {% data variables.product.prodname_copilot_chat_short %} and code completions. Some models offer lower latency, while others offer fewer hallucinations or better performance on specific tasks. +{% data variables.product.prodname_copilot %} supports multiple AI models with different capabilities. The model you choose affects the quality and relevance of responses by {% data variables.product.prodname_copilot_chat_short %} and {% data variables.product.prodname_copilot_short %} code completion. Some models offer lower latency, while others offer fewer hallucinations or better performance on specific tasks. This article helps you compare the available models, understand the strengths of each model, and choose the model that best fits your task. For guidance across different models using real-world tasks, see [AUTOTITLE](/copilot/using-github-copilot/ai-models/comparing-ai-models-using-different-tasks). diff --git a/content/copilot/using-github-copilot/best-practices-for-using-github-copilot.md b/content/copilot/using-github-copilot/best-practices-for-using-github-copilot.md index 65a170948e7e..1ae6df415649 100644 --- a/content/copilot/using-github-copilot/best-practices-for-using-github-copilot.md +++ b/content/copilot/using-github-copilot/best-practices-for-using-github-copilot.md @@ -26,9 +26,9 @@ shortTitle: Best practices ## Choose the right {% data variables.product.prodname_copilot_short %} tool for the job -While {% data variables.product.prodname_copilot_short %} code completions and {% data variables.product.prodname_copilot_chat_short %} share some functionality, the two tools are best used in different circumstances. +While {% data variables.product.prodname_copilot_short %} code completion and {% data variables.product.prodname_copilot_chat_short %} share some functionality, the two tools are best used in different circumstances. -**Code completions work best for:** +**Code completion works best for:** * Completing code snippets, variable names, and functions as you write them * Generating repetitive code @@ -73,9 +73,9 @@ There are several adjustments you can make to steer {% data variables.product.pr * If you are using {% data variables.product.prodname_copilot_chat_dotcom_short %}, provide specific repositories, files, symbols, and more as context. See [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom). * If you are using {% data variables.product.prodname_copilot_chat_short %} in your IDE, use keywords to focus {% data variables.product.prodname_copilot_short %} on a specific task or piece of context. See [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide#using-keywords-in-your-prompt). * **Rewrite your prompts to generate different responses.** If {% data variables.product.prodname_copilot_short %} is not providing a helpful response, try rephrasing your prompt, or even breaking your request down into multiple smaller prompts. -* **Pick the best available suggestion.** When you are using code completions, {% data variables.product.prodname_copilot_short %} might offer more than one suggestion. You can use keyboard shortcuts to quickly look through all available suggestions. For the default keyboard shortcuts for your operating system, see [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment#keyboard-shortcuts-for-github-copilot). +* **Pick the best available suggestion.** When you are using code completion, {% data variables.product.prodname_copilot_short %} might offer more than one suggestion. You can use keyboard shortcuts to quickly look through all available suggestions. For the default keyboard shortcuts for your operating system, see [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment#keyboard-shortcuts-for-github-copilot). * **Provide feedback to improve future suggestions.** You can provide feedback in many ways: - * For code completions, accept or reject {% data variables.product.prodname_copilot_short %}'s suggestion. + * For code completion, accept or reject {% data variables.product.prodname_copilot_short %}'s suggestion. * For individual responses in {% data variables.product.prodname_copilot_chat_short %}, click the thumbs up or thumbs down icons next to the response. * For {% data variables.product.prodname_copilot_chat_short %} in your IDE, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide#sharing-feedback) for instructions specific to your environment. * For {% data variables.product.prodname_copilot_chat_dotcom_short %}, leave a comment on the [feedback discussion](https://github.com/orgs/community/discussions/110314). diff --git a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot.md b/content/copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot.md similarity index 96% rename from content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot.md rename to content/copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot.md index a2deafab1b77..79c2d0dfea85 100644 --- a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot.md +++ b/content/copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot.md @@ -8,6 +8,7 @@ topics: - Copilot type: overview redirect_from: + - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/about-assigning-issues-to-copilot - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/about-assigning-tasks-to-copilot --- @@ -47,7 +48,7 @@ Having {% data variables.product.prodname_copilot_short %} as an additional codi ### Making {% data variables.copilot.copilot_coding_agent %} available -Before you can assign tasks to {% data variables.product.prodname_copilot_short %}, it must be enabled. See [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/enabling-copilot-coding-agent). +Before you can assign tasks to {% data variables.product.prodname_copilot_short %}, it must be enabled. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/enabling-copilot-coding-agent). ## {% data variables.copilot.copilot_coding_agent %} usage costs @@ -70,7 +71,7 @@ To mitigate this risk, {% data variables.product.github %}: * **Limits who can assign tasks to {% data variables.product.prodname_copilot_short %}.** Only users with write access to the repository can trigger {% data variables.product.prodname_copilot_short %} to work. Comments from users without write access are never presented to the agent. * **Limits the permissions in access tokens used by Copilot.** Pushes are only allowed to branches beginning with `copilot/`. {% data variables.product.prodname_copilot_short %} cannot push to the `main` or `master` branches. * **Limits {% data variables.product.prodname_copilot_short %}'s credentials.** {% data variables.product.prodname_copilot_short %} can only perform simple push operations. It cannot directly run `git push` or other Git commands. -* **Restricts {% data variables.product.prodname_actions %} workflow runs.** Workflows are not triggered until {% data variables.product.prodname_copilot_short %}'s code is reviewed and a user with write access to the repo clicks the **Approve and run workflows** button. See [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-copilot-to-work-on-an-issue#allowing-github-actions-workflows-to-run-when-copilot-pushes-changes). +* **Restricts {% data variables.product.prodname_actions %} workflow runs.** Workflows are not triggered until {% data variables.product.prodname_copilot_short %}'s code is reviewed and a user with write access to the repo clicks the **Approve and run workflows** button. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/using-copilot-to-work-on-an-issue#allowing-github-actions-workflows-to-run-when-copilot-pushes-changes). * **Prevents the user who asked {% data variables.product.prodname_copilot_short %} to create a pull request from approving it.** This maintains the expected controls in the "Required reviews" rule and branch protection. See [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets). ### Risk: {% data variables.product.prodname_copilot_short %} has access to sensitive information @@ -105,7 +106,7 @@ Users can include hidden messages in issues assigned to {% data variables.produc ## Further reading -* [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks) +* [AUTOTITLE](/copilot/using-github-copilot/coding-agent) * [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-copilot-coding-agent-on-githubcom) * [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent) * [AUTOTITLE](/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent) diff --git a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/asking-copilot-to-create-a-pull-request.md b/content/copilot/using-github-copilot/coding-agent/asking-copilot-to-create-a-pull-request.md similarity index 83% rename from content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/asking-copilot-to-create-a-pull-request.md rename to content/copilot/using-github-copilot/coding-agent/asking-copilot-to-create-a-pull-request.md index d5bd198cdb72..b326a243cec7 100644 --- a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/asking-copilot-to-create-a-pull-request.md +++ b/content/copilot/using-github-copilot/coding-agent/asking-copilot-to-create-a-pull-request.md @@ -9,6 +9,7 @@ topics: - Copilot type: how_to redirect_from: + - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/asking-copilot-to-create-a-pull-request - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/asking-copilot-to-create-a-pull-request --- @@ -22,7 +23,7 @@ Often, when you are working on a project, you might notice a change you want to Instead—if {% data variables.copilot.copilot_coding_agent %} is available—you can ask {% data variables.product.prodname_copilot_short %} to make the change for you. {% data variables.product.prodname_copilot_short %} will start working on the change in the background and, when it's done, request you to review the pull request it raises. -For information on making {% data variables.copilot.copilot_coding_agent %} available, see [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/enabling-copilot-coding-agent). +For information on making {% data variables.copilot.copilot_coding_agent %} available, see [AUTOTITLE](/copilot/using-github-copilot/coding-agent/enabling-copilot-coding-agent). ## Creating a pull request from {% data variables.product.prodname_copilot_chat_short %} @@ -43,12 +44,12 @@ For information on making {% data variables.copilot.copilot_coding_agent %} avai ## Monitoring progress -You can see what {% data variables.product.prodname_copilot_short %} is doing while it is working on a task by viewing the session logs. See [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-the-copilot-coding-agent-logs). +You can see what {% data variables.product.prodname_copilot_short %} is doing while it is working on a task by viewing the session logs. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs). You can also stop {% data variables.product.prodname_copilot_short %} from working on a task by clicking **Stop session** in the session logs. ## Further reading -* [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot) -* [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/best-practices-for-using-copilot-to-work-on-tasks) -* [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/troubleshooting-copilot-coding-agent#copilot-cant-create-a-pull-request-from-copilot-chat) +* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot) +* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks) +* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent#copilot-cant-create-a-pull-request-from-copilot-chat) diff --git a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/best-practices-for-using-copilot-to-work-on-tasks.md b/content/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks.md similarity index 90% rename from content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/best-practices-for-using-copilot-to-work-on-tasks.md rename to content/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks.md index fb0f2eb2a2a1..026a8ee528a9 100644 --- a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/best-practices-for-using-copilot-to-work-on-tasks.md +++ b/content/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks.md @@ -9,6 +9,7 @@ topics: - Copilot type: reference redirect_from: + - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/best-practices-for-using-copilot-to-work-on-tasks - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/best-practices-for-using-copilot-to-work-on-issues - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/best-practices-for-using-copilot-to-work-on-tasks - /early-access/copilot/coding-agent/best-practices-for-using-copilot-coding-agent @@ -54,7 +55,10 @@ Issues that you may choose to work on yourself, rather than assigning to {% data Working with {% data variables.product.prodname_copilot_short %} on a pull request is just like working with a human developer: it's common for the pull request to need further work before it can be merged. The process for getting the pull request to a mergeable state is exactly the same when the pull request is created by {% data variables.product.prodname_copilot_short %} as when it's created by a human. If you want, you can work on the feature branch yourself and push changes to the pull request. However, you can also just add comments to the pull request—explaining what you think is incorrect, or could be improved—and leave {% data variables.product.prodname_copilot_short %} to make the required changes. -{% data variables.product.prodname_copilot_short %} will read all comments as soon as they are submitted, and will decide whether they require action. It will then start to make any required changes, and will update the pull request when it's done. Because {% data variables.product.prodname_copilot_short %} starts looking at comments as soon as they are submitted, if you are likely to make multiple comments on a pull request it's best to batch them by clicking **Start a review**, rather than clicking **Add single comment**. You can then submit all of your comments at once, triggering {% data variables.product.prodname_copilot_short %} to work on your entire review, rather than working on individual comments separately. +{% data variables.product.prodname_copilot_short %} will read all comments as soon as they are submitted by users with write access, and will decide whether they require action. It will then start to make any required changes, and will update the pull request when it's done. Because {% data variables.product.prodname_copilot_short %} starts looking at comments as soon as they are submitted, if you are likely to make multiple comments on a pull request it's best to batch them by clicking **Start a review**, rather than clicking **Add single comment**. You can then submit all of your comments at once, triggering {% data variables.product.prodname_copilot_short %} to work on your entire review, rather than working on individual comments separately. + +> [!NOTE] +> {% data reusables.copilot.coding-agent.write-access-required %} ## Adding custom instructions to your repository diff --git a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/enabling-copilot-coding-agent.md b/content/copilot/using-github-copilot/coding-agent/enabling-copilot-coding-agent.md similarity index 93% rename from content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/enabling-copilot-coding-agent.md rename to content/copilot/using-github-copilot/coding-agent/enabling-copilot-coding-agent.md index 94cb5aeb3f98..e3087cf47516 100644 --- a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/enabling-copilot-coding-agent.md +++ b/content/copilot/using-github-copilot/coding-agent/enabling-copilot-coding-agent.md @@ -8,6 +8,7 @@ topics: - Copilot type: how_to redirect_from: + - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/enabling-copilot-coding-agent - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/enabling-copilot-coding-agent-for-your-personal-repositories - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/enabling-copilot-coding-agent-for-your-personal-repositories --- @@ -30,7 +31,7 @@ If you want {% data variables.copilot.copilot_coding_agent %} to be available in ## Further reading -* [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks) +* [AUTOTITLE](/copilot/using-github-copilot/coding-agent) * [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent) * [AUTOTITLE](/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent) * [AUTOTITLE](/copilot/customizing-copilot/extending-copilot-coding-agent-with-mcp) diff --git a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/index.md b/content/copilot/using-github-copilot/coding-agent/index.md similarity index 87% rename from content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/index.md rename to content/copilot/using-github-copilot/coding-agent/index.md index 080eee478e02..cacd26f65371 100644 --- a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/index.md +++ b/content/copilot/using-github-copilot/coding-agent/index.md @@ -1,5 +1,5 @@ --- -title: Using Copilot to work on tasks +title: Coding agent intro: 'Find out how {% data variables.product.prodname_copilot_short %} can work on {% data variables.product.github %} issues and raise pull requests for your to review.' versions: feature: copilot @@ -15,6 +15,7 @@ children: - /using-the-copilot-coding-agent-logs - /troubleshooting-copilot-coding-agent redirect_from: + - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues - /early-access/copilot/coding-agent --- diff --git a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/reviewing-a-pull-request-created-by-copilot.md b/content/copilot/using-github-copilot/coding-agent/reviewing-a-pull-request-created-by-copilot.md similarity index 84% rename from content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/reviewing-a-pull-request-created-by-copilot.md rename to content/copilot/using-github-copilot/coding-agent/reviewing-a-pull-request-created-by-copilot.md index dca64162a91d..6811ed235f01 100644 --- a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/reviewing-a-pull-request-created-by-copilot.md +++ b/content/copilot/using-github-copilot/coding-agent/reviewing-a-pull-request-created-by-copilot.md @@ -8,6 +8,8 @@ versions: topics: - Copilot type: how_to +redirect_from: + - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/reviewing-a-pull-request-created-by-copilot --- {% data reusables.copilot.coding-agent.preview-note %} @@ -26,7 +28,9 @@ You can ask {% data variables.product.prodname_copilot_short %} to make changes When you leave a comment on {% data variables.product.prodname_copilot_short %}'s pull request, {% data variables.product.prodname_copilot_short %} will consider your comment, and decide whether to start a new agent session to respond. -If {% data variables.product.prodname_copilot_short %} starts a new agent session in response to your comment, {% data variables.product.prodname_copilot_short %} will react with 👀, and a "Copilot has started work" event will appear in the pull request timeline. +{% data reusables.copilot.coding-agent.write-access-required %} + +If {% data variables.product.prodname_copilot_short %} starts a new agent session in response to your comment, an eyes emoji (👀) is added as a reaction to the comment, and a "Copilot has started work" event is added to the pull request timeline. ![Screenshot of a pull request timeline with a review comment with the eyes reaction and a "Copilot started work" timeline event.](/assets/images/help/copilot/coding-agent/comment-to-agent-on-pr.png) @@ -35,7 +39,7 @@ If {% data variables.product.prodname_copilot_short %} starts a new agent sessio > [!TIP] > If you don't want {% data variables.product.prodname_copilot_short %} to respond to comments on a pull request, you can unassign {% data variables.product.prodname_copilot_short %} from the pull request. If you later reassign {% data variables.product.prodname_copilot_short %} to the same pull request it will respond to new comments and push more changes. It will not respond to comment that were added while it was not assigned. -For more information, see the section "Use comments to iterate on a pull request" in [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/best-practices-for-using-copilot-to-work-on-tasks#using-comments-to-iterate-on-a-pull-request). +For more information, see the section "Use comments to iterate on a pull request" in [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks#using-comments-to-iterate-on-a-pull-request). ## Managing {% data variables.product.prodname_actions %} workflow runs @@ -56,6 +60,6 @@ You can provide feedback on {% data variables.product.prodname_copilot_short %}' ## Further reading -* [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/best-practices-for-using-copilot-to-work-on-tasks) -* [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-the-copilot-coding-agent-logs) -* [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/troubleshooting-copilot-coding-agent) +* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks) +* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs) +* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent) diff --git a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/troubleshooting-copilot-coding-agent.md b/content/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent.md similarity index 86% rename from content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/troubleshooting-copilot-coding-agent.md rename to content/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent.md index 0b784c9750ff..66b8a8b80e39 100644 --- a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/troubleshooting-copilot-coding-agent.md +++ b/content/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent.md @@ -9,6 +9,7 @@ topics: - Copilot type: reference redirect_from: + - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/troubleshooting-copilot-coding-agent - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/troubleshooting-copilot-coding-agent - /early-access/copilot/coding-agent/troubleshooting-copilot-coding-agent --- @@ -54,11 +55,11 @@ If there is a "{% data variables.product.prodname_copilot_short %} started work" ## {% data variables.product.prodname_copilot_short %} won't respond to my pull request comments -When you leave a pull request comment on a pull request that is assigned to {% data variables.product.prodname_copilot_short %}, {% data variables.product.prodname_copilot_short %} will consider your comment, and decide whether to start a new agent session to respond. +{% data reusables.copilot.coding-agent.write-access-required %} -If {% data variables.product.prodname_copilot_short %} decides to take action and start a new agent session in response to your comment, it will leave an 👀 reaction on the comment, and then a "{% data variables.product.prodname_copilot_short %} started work" event will appear in the pull request timeline. +If you do have write access, and you add a comment on a pull request that is assigned to {% data variables.product.prodname_copilot_short %}, the comment is passed to {% data variables.copilot.copilot_coding_agent %}. An eyes emoji (👀) is added to your comment to indicate that {% data variables.copilot.copilot_coding_agent %} is considering your comment. If the agent proceeds to work on making changes in response to your comment a "{% data variables.product.prodname_copilot_short %} started work" event is added to the pull request timeline. -If this doesn't happen, you may have unassigned {% data variables.product.prodname_copilot_short %} from the pull request, or {% data variables.product.prodname_copilot_short %} may have decided that your comment is not actionable. +If this doesn't happen, {% data variables.product.prodname_copilot_short %} may have been unassigned from the pull request, or {% data variables.product.prodname_copilot_short %} may have decided that your comment is not actionable. Check that {% data variables.product.prodname_copilot_short %} is assigned to the pull request. If it is, you can force {% data variables.product.prodname_copilot_short %} to respond to your comment by @mentioning {% data variables.product.prodname_copilot_short %} in the comment with `@copilot`. @@ -74,13 +75,13 @@ If {% data variables.product.prodname_copilot_short %} got stuck while respondin {% data variables.product.prodname_actions %} workflows will not run automatically when {% data variables.product.prodname_copilot_short %} pushes changes to a pull request. -To allow {% data variables.product.prodname_actions %} workflows to run, click the **Approve and run workflows** button in the pull request's merge box. See [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-copilot-to-work-on-an-issue#allowing-github-actions-workflows-to-run-when-copilot-pushes-changes). +To allow {% data variables.product.prodname_actions %} workflows to run, click the **Approve and run workflows** button in the pull request's merge box. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/using-copilot-to-work-on-an-issue#allowing-github-actions-workflows-to-run-when-copilot-pushes-changes). ## {% data variables.product.prodname_copilot_short %} is pushing changes which don't pass my CI checks While working on an issue, {% data variables.product.prodname_copilot_short %} has access to its own ephemeral development environment, powered by {% data variables.product.prodname_actions %}, where it can execute automated tests and linters to validate its work before it pushes. -It is most likely to do this if given clear instructions on what to do. The best way to do this is with a `.github/copilot-instructions.md` file. See [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/best-practices-for-using-copilot-to-work-on-tasks#adding-custom-instructions-to-your-repository). +It is most likely to do this if given clear instructions on what to do. The best way to do this is with a `.github/copilot-instructions.md` file. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks#adding-custom-instructions-to-your-repository). ## There is a warning from {% data variables.product.prodname_copilot %} about the firewall @@ -96,5 +97,5 @@ For more information, see [AUTOTITLE](/copilot/customizing-copilot/customizing-o ## Further reading -* [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/best-practices-for-using-copilot-to-work-on-tasks) +* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks) * [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent) diff --git a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-copilot-to-work-on-an-issue.md b/content/copilot/using-github-copilot/coding-agent/using-copilot-to-work-on-an-issue.md similarity index 93% rename from content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-copilot-to-work-on-an-issue.md rename to content/copilot/using-github-copilot/coding-agent/using-copilot-to-work-on-an-issue.md index bc45b9cf50ac..017bb689b2ef 100644 --- a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-copilot-to-work-on-an-issue.md +++ b/content/copilot/using-github-copilot/coding-agent/using-copilot-to-work-on-an-issue.md @@ -8,6 +8,7 @@ topics: - Copilot type: how_to redirect_from: + - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-copilot-to-work-on-an-issue - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/using-copilot-to-work-on-an-issue - /early-access/copilot/coding-agent/using-copilot-coding-agent --- @@ -16,9 +17,9 @@ redirect_from: ## Introduction -You can assign a {% data variables.product.github %} issue to {% data variables.product.prodname_copilot_short %}, just like you would with a human software developer. {% data variables.product.prodname_copilot_short %} will start working on the issue, raise a pull request and when it's finished working, request a review from you. For more information, see [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot). +You can assign a {% data variables.product.github %} issue to {% data variables.product.prodname_copilot_short %}, just like you would with a human software developer. {% data variables.product.prodname_copilot_short %} will start working on the issue, raise a pull request and when it's finished working, request a review from you. For more information, see [AUTOTITLE](/copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot). -If you haven't used {% data variables.product.prodname_copilot_short %} to work on an issue before, you can find some useful advice for getting good results in [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/best-practices-for-using-copilot-to-work-on-tasks). +If you haven't used {% data variables.product.prodname_copilot_short %} to work on an issue before, you can find some useful advice for getting good results in [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks). ## Assigning an issue to {% data variables.product.prodname_copilot_short %} @@ -132,7 +133,7 @@ A few seconds later, {% data variables.product.prodname_copilot_short %} will op ![Screenshot of a pull request with a series of timeline events, including "Copilot started work."](/assets/images/help/copilot/coding-agent/copilot-started-work.png) -If you want to check what {% data variables.product.prodname_copilot_short %} is doing, click **View session**. The session log viewer is displayed, showing you a live log as {% data variables.product.prodname_copilot_short %} works on the issue. If you want to stop {% data variables.product.prodname_copilot_short %} from working on the issue, click **Stop session**. See [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-the-copilot-coding-agent-logs). +If you want to check what {% data variables.product.prodname_copilot_short %} is doing, click **View session**. The session log viewer is displayed, showing you a live log as {% data variables.product.prodname_copilot_short %} works on the issue. If you want to stop {% data variables.product.prodname_copilot_short %} from working on the issue, click **Stop session**. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs). Once {% data variables.product.prodname_copilot_short %} has finished, the agent session will end, and {% data variables.product.prodname_copilot_short %} will request a review from you, triggering a notification. In addition, a "{% data variables.product.prodname_copilot_short %} finished work" event will appear in the pull request timeline. @@ -140,9 +141,9 @@ Once {% data variables.product.prodname_copilot_short %} has finished, the agent ## Working with {% data variables.product.prodname_copilot_short %} on a pull request -After {% data variables.product.prodname_copilot_short %} has finished working on the issue, you should review the pull request thoroughly and comment on anything that needs changed. See [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/reviewing-a-pull-request-created-by-copilot). +After {% data variables.product.prodname_copilot_short %} has finished working on the issue, you should review the pull request thoroughly and comment on anything that needs changed. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/reviewing-a-pull-request-created-by-copilot). ## Further reading -* [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/best-practices-for-using-copilot-to-work-on-tasks) -* [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/troubleshooting-copilot-coding-agent) +* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks) +* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent) diff --git a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-the-copilot-coding-agent-logs.md b/content/copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs.md similarity index 86% rename from content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-the-copilot-coding-agent-logs.md rename to content/copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs.md index 23e53303b977..57f0a00b73e4 100644 --- a/content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-the-copilot-coding-agent-logs.md +++ b/content/copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs.md @@ -8,13 +8,15 @@ versions: topics: - Copilot type: how_to +redirect_from: + - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-the-copilot-coding-agent-logs --- {% data reusables.copilot.coding-agent.preview-note %} ## Introduction -After you assign an issue to {% data variables.product.prodname_copilot_short %}, or use {% data variables.product.prodname_copilot_chat_short %} to ask {% data variables.product.prodname_copilot_short %} to create a pull request, {% data variables.product.prodname_copilot_short %} works autonomously to complete the task. See [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot). +After you assign an issue to {% data variables.product.prodname_copilot_short %}, or use {% data variables.product.prodname_copilot_chat_short %} to ask {% data variables.product.prodname_copilot_short %} to create a pull request, {% data variables.product.prodname_copilot_short %} works autonomously to complete the task. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot). During or after an agent session, you can inspect the session logs to understand {% data variables.product.prodname_copilot_short %}'s approach to your problem. @@ -43,5 +45,5 @@ Reasons you might want to stop a session include: ## Further reading -* [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/best-practices-for-using-copilot-to-work-on-tasks) -* [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/troubleshooting-copilot-coding-agent) +* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks) +* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent) diff --git a/content/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot.md b/content/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot.md index ef37962e6e1c..d70f5437ba4b 100644 --- a/content/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot.md +++ b/content/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot.md @@ -251,7 +251,7 @@ This guide demonstrates how to get coding suggestions from {% data variables.pro {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_vscode_shortname %} provides two kinds of suggestions: -* **Code completions**. {% data variables.product.prodname_copilot_short %} offers coding suggestions as you type. You can also describe something you want to do using natural language within a comment, and {% data variables.product.prodname_copilot_short %} will suggest the code to accomplish your goal. +* **Code completion**. {% data variables.product.prodname_copilot_short %} offers coding suggestions as you type. You can also describe something you want to do using natural language within a comment, and {% data variables.product.prodname_copilot_short %} will suggest the code to accomplish your goal. * **{% data variables.copilot.next_edit_suggestions_caps %} ({% data variables.release-phases.public_preview %})**. Based on the edits you are making, {% data variables.product.prodname_copilot_short %} will predict the location of the next edit you are likely to make and suggest a completion for it. The examples in this guide use JavaScript, however other languages will work similarly. {% data reusables.copilot.supported-languages %} @@ -365,7 +365,7 @@ An arrow in the gutter indicates an available edit suggestion. Hover over the ar ![Screenshot of the gutter menu in {% data variables.product.prodname_vscode %}. The arrow is outlined in dark orange.](/assets/images/help/copilot/vsc-advanced-code-completion-menu.png) -For more details and examples, see [Code completions with {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode_shortname %}](https://aka.ms/gh-copilot-nes-docs) in the {% data variables.product.prodname_vscode %} documentation. +For more details and examples, see [Code completions with {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/docs/copilot/ai-powered-suggestions) in the {% data variables.product.prodname_vscode %} documentation. ## Changing the AI model diff --git a/content/copilot/using-github-copilot/guides-on-using-github-copilot/choosing-the-right-ai-tool-for-your-task.md b/content/copilot/using-github-copilot/guides-on-using-github-copilot/choosing-the-right-ai-tool-for-your-task.md index 6062128dbc98..72f8091d2583 100644 --- a/content/copilot/using-github-copilot/guides-on-using-github-copilot/choosing-the-right-ai-tool-for-your-task.md +++ b/content/copilot/using-github-copilot/guides-on-using-github-copilot/choosing-the-right-ai-tool-for-your-task.md @@ -18,7 +18,7 @@ The use of AI tools is increasingly becoming a standard part of a software devel * {% data variables.product.prodname_copilot_short %} can create issues to help track your ideas. * {% data variables.product.prodname_copilot_chat_short %} can help you brainstorm and identify the best technologies for your project. * **Code creation**: - * {% data variables.product.prodname_copilot_short %} code completions helps add code as you type. + * {% data variables.product.prodname_copilot_short %} code completion helps add code as you type. * {% data variables.copilot.next_edit_suggestions_caps %} ({% data variables.release-phases.public_preview %}) predicts the next edit you are likely to make and suggests a completion for it. * {% data variables.product.prodname_copilot_chat_short %} can answer questions and offer suggestions in a conversational environment. * You can assign {% data variables.copilot.copilot_coding_agent %} to an open issue and it will automatically raise a pull request to address the necessary changes. @@ -46,7 +46,7 @@ Once you've chosen an issue to address, **{% data variables.product.prodname_cop During the creation phase, you'll write and refine the code for your application. This is where you can bring the project to life by implementing features, fixing bugs, and iterating on the codebase. -{% data variables.product.prodname_copilot_short %} provides auto-complete style **coding suggestions** as you code in your favorite IDE or on {% data variables.product.github %}, helping you draft and refine your code faster. You can write code directly or describe your intent in natural language using comments in your IDE, and {% data variables.product.prodname_copilot_short %} will generate relevant suggestions. +{% data variables.product.prodname_copilot_short %} provides auto-complete style **coding suggestions** as you code in your favorite IDE or on {% data variables.product.github %}, helping you draft and refine your code faster. You can write code directly or describe your intent in natural language using comments in your IDE, and {% data variables.product.prodname_copilot_short %} will generate relevant suggestions. With **{% data variables.copilot.next_edit_suggestions %}** ({% data variables.release-phases.public_preview %}), {% data variables.product.prodname_copilot_short %} predicts related edits based on the changes you’re actively making. For example, if you rename a variable or update a function’s parameters, it suggests corresponding updates throughout your code. This helps maintain consistency and reduces the chance of errors. diff --git a/content/copilot/using-github-copilot/index.md b/content/copilot/using-github-copilot/index.md index 1f83d344e289..daf0d404f415 100644 --- a/content/copilot/using-github-copilot/index.md +++ b/content/copilot/using-github-copilot/index.md @@ -10,7 +10,7 @@ children: - /best-practices-for-using-github-copilot - /getting-code-suggestions-in-your-ide-with-github-copilot - /copilot-chat - - /using-copilot-coding-agent-to-work-on-tasks + - /coding-agent - /asking-github-copilot-questions-in-windows-terminal - /using-copilot-text-completion - /code-review diff --git a/content/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat.md b/content/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat.md index d44049060cde..8f587d9ada41 100644 --- a/content/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat.md +++ b/content/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat.md @@ -18,7 +18,7 @@ redirect_from: {% data reusables.copilot.copilot-extensions.copilot-extensions-intro %} -> [!NOTE] {% data variables.product.prodname_copilot_extensions %} are not the same as _the {% data variables.product.prodname_copilot %} extension_, which you install in your IDE to use default {% data variables.product.prodname_copilot_short %} functionality like code completions and {% data variables.product.prodname_copilot_chat %}. For more information on _the {% data variables.product.prodname_copilot %} extension_, see [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment). +> [!NOTE] {% data variables.product.prodname_copilot_extensions %} are not the same as _the {% data variables.product.prodname_copilot %} extension_, which you install in your IDE to use default {% data variables.product.prodname_copilot_short %} functionality like code completion and {% data variables.product.prodname_copilot_chat %}. For more information on _the {% data variables.product.prodname_copilot %} extension_, see [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment). You can get started with {% data variables.product.prodname_copilot_extensions_short %} in one of two ways: * Build your own {% data variables.product.prodname_copilot_extension_short %}. See [AUTOTITLE](/copilot/building-copilot-extensions/about-building-copilot-extensions). diff --git a/content/copilot/using-github-copilot/using-github-copilot-to-create-issues.md b/content/copilot/using-github-copilot/using-github-copilot-to-create-issues.md index c329ac6d5410..ab62b0425518 100644 --- a/content/copilot/using-github-copilot/using-github-copilot-to-create-issues.md +++ b/content/copilot/using-github-copilot/using-github-copilot-to-create-issues.md @@ -63,7 +63,7 @@ Each draft appears separately, and you can review and edit them individually. To ## Assigning issues to {% data variables.product.prodname_copilot_short %} -To assign an issue to {% data variables.product.prodname_copilot_short %}, you need to have {% data variables.copilot.copilot_coding_agent %} enabled. See [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/enabling-copilot-coding-agent). +To assign an issue to {% data variables.product.prodname_copilot_short %}, you need to have {% data variables.copilot.copilot_coding_agent %} enabled. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/enabling-copilot-coding-agent). You can assign the issue during creation in one of two ways: diff --git a/content/get-started/learning-to-code/setting-up-copilot-for-learning-to-code.md b/content/get-started/learning-to-code/setting-up-copilot-for-learning-to-code.md index f94d901ab3f2..66a1753ceccf 100644 --- a/content/get-started/learning-to-code/setting-up-copilot-for-learning-to-code.md +++ b/content/get-started/learning-to-code/setting-up-copilot-for-learning-to-code.md @@ -18,9 +18,9 @@ In this guide, you’ll learn how to set up {% data variables.product.prodname_c This guide assumes that you'll use {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_vscode_shortname %}. To get set up, see [Set up Copilot in {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/docs/copilot/setup-simplified) in the {% data variables.product.prodname_vscode %} documentation. -## Step 1: Disable code completions +## Step 1: Disable code completion -First, let's disable code completions. This will give you the opportunity to deepen your understanding of programming concepts by writing more code yourself. +First, let's disable code completion. This will give you the opportunity to deepen your understanding of programming concepts by writing more code yourself. 1. In {% data variables.product.prodname_vscode_shortname %}, open your project. 1. Create a folder in the root directory called `.vscode`. @@ -35,7 +35,7 @@ First, let's disable code completions. This will give you the opportunity to dee } ``` -1. Save the file. {% data variables.product.prodname_copilot_short %} code completions are now disabled for this project in {% data variables.product.prodname_vscode_shortname %}. +1. Save the file. {% data variables.product.prodname_copilot_short %} code completion is now disabled for this project in {% data variables.product.prodname_vscode_shortname %}. ## Step 2: Add learning instructions @@ -49,8 +49,8 @@ Now, let's provide {% data variables.product.prodname_copilot_chat_short %} with Do not provide code snippets, even if I ask you for implementation advice in my prompts. Teach me all the basic coding concepts in your answers. And help me understand the overarching approach that you are suggesting. - Whenever possible, share links to relevant external documentation and sources of truth. - + Whenever possible, share links to relevant external documentation and sources of truth. + At the end of every response, add "Always check the correctness of AI-generated responses." ``` diff --git a/content/index.md b/content/index.md index bb8eab660f91..dc84bc28b192 100644 --- a/content/index.md +++ b/content/index.md @@ -110,7 +110,7 @@ childGroups: - copilot/using-github-copilot/copilot-chat/prompt-engineering-for-copilot-chat - copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github - copilot/copilot-chat-cookbook - - copilot/building-copilot-extensions/quickstart-for-github-copilot-extensions-using-agents + - copilot/using-github-copilot/coding-agent - name: CI/CD and DevOps octicon: GearIcon children: diff --git a/content/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users.md b/content/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users.md index 50a9352c4c38..9a905f38506a 100644 --- a/content/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users.md +++ b/content/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users.md @@ -23,7 +23,7 @@ You can assign multiple people to each issue or pull request, including: yoursel {% ifversion copilot %} -You may also be able to assign {% data variables.product.prodname_copilot_short %} to an issue, see [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-copilot-to-work-on-an-issue). +You may also be able to assign {% data variables.product.prodname_copilot_short %} to an issue, see [AUTOTITLE](/copilot/using-github-copilot/coding-agent/using-copilot-to-work-on-an-issue). {% endif %} @@ -53,7 +53,7 @@ Issues and pull requests in public repositories, and in private repositories for ## Assigning an issue to {% data variables.product.prodname_copilot_short %} -If you assign an issue to {% data variables.product.prodname_copilot_short %}, {% data variables.product.prodname_copilot_short %} will work autonomously on the issue, creating a pull request and, when it has finished, requesting that you review the pull request. See [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot). +If you assign an issue to {% data variables.product.prodname_copilot_short %}, {% data variables.product.prodname_copilot_short %} will work autonomously on the issue, creating a pull request and, when it has finished, requesting that you review the pull request. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot). {% endif %} diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md index 802e1e31ee7d..5b962a31e20a 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md @@ -60,4 +60,4 @@ You can view all of the reviews a pull request has received in the Conversation * [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/viewing-a-pull-request-review) * [AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors){% ifversion copilot %} * [AUTOTITLE](/copilot/using-github-copilot/code-review/using-copilot-code-review) -* [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-copilot-to-work-on-an-issue){% endif %} +* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/using-copilot-to-work-on-an-issue){% endif %} diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md index 4c8c904835b9..c47b8101bfe4 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request.md @@ -52,7 +52,7 @@ To reply to an existing line or file comment, you'll need to navigate to the com When you have finished, click **Finish your review** at the top right of the page, leave a summary of your review, and click **Submit review**. -Anyone watching the pull request or repository will receive a notification of your comments. Batching your comments avoids multiple notifications being sent. {% ifversion copilot %}If you are commenting on a pull request created by {% data variables.product.prodname_copilot_short %}, batching your comments prevents {% data variables.product.prodname_copilot_short %} from starting to work on individual comments before you have completed your review. See [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-copilot-to-work-on-an-issue).{% endif %} +Anyone watching the pull request or repository will receive a notification of your comments. Batching your comments avoids multiple notifications being sent. {% ifversion copilot %}If you are commenting on a pull request created by {% data variables.product.prodname_copilot_short %}, batching your comments prevents {% data variables.product.prodname_copilot_short %} from starting to work on individual comments before you have completed your review. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/using-copilot-to-work-on-an-issue).{% endif %} {% data reusables.pull_requests.resolving-conversations %} diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md index f0955f4cec43..34d95c097b95 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request.md @@ -20,7 +20,7 @@ You can review changes in a pull request one file at a time. While reviewing the {% ifversion copilot %} -If the pull request was raised by {% data variables.product.prodname_copilot %} then, when you submit your comments, {% data variables.product.prodname_copilot_short %} will carry out more work to respond to your comments and will push a new commit to the pull request with further changes. See [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot). +If the pull request was raised by {% data variables.product.prodname_copilot %} then, when you submit your comments, {% data variables.product.prodname_copilot_short %} will carry out more work to respond to your comments and will push a new commit to the pull request with further changes. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot). {% endif %} diff --git a/data/reusables/copilot/coding-agent/agent-availability.md b/data/reusables/copilot/coding-agent/agent-availability.md index 03ff167a26ff..b0b6de5f0a6a 100644 --- a/data/reusables/copilot/coding-agent/agent-availability.md +++ b/data/reusables/copilot/coding-agent/agent-availability.md @@ -1 +1 @@ -For information on making {% data variables.copilot.copilot_coding_agent %} available, see [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/enabling-copilot-coding-agent). +For information on making {% data variables.copilot.copilot_coding_agent %} available, see [AUTOTITLE](/copilot/using-github-copilot/coding-agent/enabling-copilot-coding-agent). diff --git a/data/reusables/copilot/coding-agent/write-access-required.md b/data/reusables/copilot/coding-agent/write-access-required.md new file mode 100644 index 000000000000..da615be0ec1f --- /dev/null +++ b/data/reusables/copilot/coding-agent/write-access-required.md @@ -0,0 +1 @@ +{% data variables.product.prodname_copilot_short %} only responds to comments from people who have write access to the repository. diff --git a/data/reusables/copilot/differences-cfi-cfb-table.md b/data/reusables/copilot/differences-cfi-cfb-table.md index 5a0b91c1aae0..8f99143c8ee4 100644 --- a/data/reusables/copilot/differences-cfi-cfb-table.md +++ b/data/reusables/copilot/differences-cfi-cfb-table.md @@ -14,6 +14,7 @@ | Agents | {% data variables.product.prodname_copilot_free_short %} | {% data variables.product.prodname_copilot_pro_short %} | {% data variables.product.prodname_copilot_pro_plus_short %} | {% data variables.product.prodname_copilot_business_short %} | {% data variables.product.prodname_copilot_enterprise_short %} | | --- | --- | --- | --- | --- | --- | +| {% data variables.copilot.copilot_coding_agent %} ({% data variables.release-phases.public_preview %}) | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | | Agent mode in {% data variables.product.prodname_vscode_shortname %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | | {% data variables.product.prodname_copilot_short %} code review | Only "Review selection" in {% data variables.product.prodname_vscode_shortname %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | | {% data variables.product.prodname_copilot_extensions_short %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | diff --git a/data/reusables/copilot/enabling-or-disabling-in-vsc.md b/data/reusables/copilot/enabling-or-disabling-in-vsc.md index 7bc0e08ea764..7645b5531ec6 100644 --- a/data/reusables/copilot/enabling-or-disabling-in-vsc.md +++ b/data/reusables/copilot/enabling-or-disabling-in-vsc.md @@ -1,8 +1,8 @@ -## Enabling or disabling {% data variables.product.prodname_copilot %} code completions +## Enabling or disabling {% data variables.product.prodname_copilot %} code completion You can enable or disable {% data variables.product.prodname_copilot %} from within {% data variables.product.prodname_vscode %}. -1. To configure code completions, click the arrow next to the **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %}** icon in the title bar of {% data variables.product.prodname_vscode %}, then select **Configure code completions**. +1. To configure code completion, click the arrow next to the **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %}** icon in the title bar of {% data variables.product.prodname_vscode %}, then select **Configure code completions**. ![Screenshot of the option in the {% data variables.product.prodname_copilot %} dropdown. Configure code completions is highlighted in orange.](/assets/images/help/copilot/configure-code-completions-option-vscode.png) diff --git a/data/reusables/copilot/sku-isolation.md b/data/reusables/copilot/sku-isolation.md index 99ada5a76054..03359131fbed 100644 --- a/data/reusables/copilot/sku-isolation.md +++ b/data/reusables/copilot/sku-isolation.md @@ -4,7 +4,7 @@ As an {% ifversion ghec %}enterprise or {% endif %}organization owner, you can u Configuring {% data variables.product.prodname_copilot_sku_isolation %} will affect the following {% data variables.product.prodname_copilot_short %} features: -* Code completions in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDEs, and Vim/NeoVim +* Code completion in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDEs, and Vim/NeoVim * {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, and JetBrains IDEs * {% data variables.product.prodname_copilot_chat_short %} on {% data variables.product.github %} * {% data variables.product.prodname_mobile %} Apps diff --git a/data/reusables/copilot/vscode-version-compatibility.md b/data/reusables/copilot/vscode-version-compatibility.md index d64351c7f391..2df2d4c80a2a 100644 --- a/data/reusables/copilot/vscode-version-compatibility.md +++ b/data/reusables/copilot/vscode-version-compatibility.md @@ -1,3 +1,3 @@ Changes to {% data variables.product.prodname_copilot_chat_short %} coincide with {% data variables.product.prodname_vscode %} releases, due to {% data variables.product.prodname_copilot_chat_short %}'s deep UI integration. As a result, every new version of {% data variables.product.prodname_copilot_chat_short %} is only compatible with the latest release of {% data variables.product.prodname_vscode %}. This means that if you are using an older version of {% data variables.product.prodname_vscode %}, you will not be able to use the latest {% data variables.product.prodname_copilot_chat_short %}. -Only the latest {% data variables.product.prodname_copilot_chat_short %} versions will use the latest large language model provided by the {% data variables.product.prodname_copilot_short %} service, as even minor model upgrades require prompt changes and fixes in the extension. An older version of {% data variables.product.prodname_copilot_chat_short %} will still use the latest version of {% data variables.product.prodname_copilot_short %} code completions. +Only the latest {% data variables.product.prodname_copilot_chat_short %} versions will use the latest large language model provided by the {% data variables.product.prodname_copilot_short %} service, as even minor model upgrades require prompt changes and fixes in the extension. An older version of {% data variables.product.prodname_copilot_chat_short %} will still use the latest version of {% data variables.product.prodname_copilot_short %} code completion.