diff --git a/content/copilot/concepts/agents/code-review.md b/content/copilot/concepts/agents/code-review.md index 2f023f1b71e7..e84b81e61830 100644 --- a/content/copilot/concepts/agents/code-review.md +++ b/content/copilot/concepts/agents/code-review.md @@ -18,13 +18,9 @@ category: ## Introduction -{% data variables.product.prodname_copilot %} can review your code and provide feedback. Where possible, {% data variables.product.prodname_copilot_short %}'s feedback includes suggested changes which you can apply with a couple of clicks. +{% data variables.copilot.copilot_code-review_short %} reviews code written in any language, and provides feedback. It reviews your code from multiple angles to identify issues and suggest fixes. You can apply suggested changes with a couple of clicks. -{% data variables.product.prodname_copilot_short %} can review code written in any programming language. - -{% data variables.copilot.copilot_code-review_short %} acts as an intelligent agent, reviewing your code from various angles—such as planning, customizing, and deduplicating—to systematically uncover insights, identify issues, and suggest fixes. - -This article provides an overview of {% data variables.copilot.copilot_code-review_short %}. For instructions on how to request a code review from {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/using-copilot-code-review). +This article provides an overview of {% data variables.copilot.copilot_code-review_short %}. To learn how to request a code review from {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/using-copilot-code-review). ## Availability @@ -37,32 +33,51 @@ This article provides an overview of {% data variables.copilot.copilot_code-revi * Xcode * JetBrains IDEs -{% data variables.copilot.copilot_code-review_short %} is a premium feature, available with the {% data variables.copilot.copilot_pro_short %}, {% data variables.copilot.copilot_pro_plus_short %}, {% data variables.copilot.copilot_business_short %}, and {% data variables.copilot.copilot_enterprise_short %} plans. See [{% data variables.product.prodname_copilot_short %} plans](https://github.com/features/copilot/plans?ref_product=copilot&ref_type=purchase&ref_style=text). +{% data variables.copilot.copilot_code-review_short %} is a premium feature available with these plans: + +* {% data variables.copilot.copilot_pro_short %} +* {% data variables.copilot.copilot_pro_plus_short %} +* {% data variables.copilot.copilot_business_short %} +* {% data variables.copilot.copilot_enterprise_short %} -If you receive {% data variables.product.prodname_copilot_short %} from an organization then, to be able to request a pull request review from {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %} or in {% data variables.product.prodname_mobile %}, the **{% data variables.copilot.copilot_code-review_short %}** option must be enabled in the {% data variables.product.prodname_copilot_short %} policy settings for the organization. See [AUTOTITLE](/copilot/how-tos/administer/organizations/managing-policies-for-copilot-in-your-organization). +See [{% data variables.product.prodname_copilot_short %} plans](https://github.com/features/copilot/plans?ref_product=copilot&ref_type=purchase&ref_style=text). + +If you receive {% data variables.product.prodname_copilot_short %} from an organization, your organization must enable the **{% data variables.copilot.copilot_code-review_short %}** option in the {% data variables.product.prodname_copilot_short %} policy settings. This applies to reviews on {% data variables.product.prodname_dotcom_the_website %} or in {% data variables.product.prodname_mobile %}. See [AUTOTITLE](/copilot/how-tos/administer/organizations/managing-policies-for-copilot-in-your-organization). ## {% data variables.copilot.copilot_code-review_short %} without a {% data variables.product.prodname_copilot_short %} license -{% data variables.copilot.copilot_code-review_short %} is also available on {% data variables.product.prodname_dotcom_the_website %} for organization members **without a {% data variables.product.prodname_copilot_short %} license**, when enabled by an enterprise administrator or organization owner. This capability is available to organizations on the **{% data variables.copilot.copilot_business_short %}** and **{% data variables.copilot.copilot_enterprise_short %}** plans. +Organization members **without a {% data variables.product.prodname_copilot_short %} license** can use {% data variables.copilot.copilot_code-review_short %} on {% data variables.product.prodname_dotcom_the_website %}. An enterprise administrator or organization owner must enable it. This capability is available to organizations on **{% data variables.copilot.copilot_business_short %}** and **{% data variables.copilot.copilot_enterprise_short %}** plans. + +### Enabling code review for users without a license To allow organization members without a {% data variables.product.prodname_copilot_short %} license to use {% data variables.copilot.copilot_code-review_short %}, you must enable two policies: -1. **Premium request paid usage**. This must be enabled first. It allows the enterprise or organization to incur charges for {% data variables.copilot.copilot_code-review_short %} premium request usage. +1. **Premium request paid usage**. Enable this policy first. It allows the enterprise or organization to incur charges for {% data variables.copilot.copilot_code-review_short %} premium request usage. 1. **Allow members without a {% data variables.product.prodname_copilot_short %} license to use {% data variables.copilot.copilot_code-review_short %} in {% data variables.product.prodname_dotcom_the_website %}**. This sub-policy enables {% data variables.copilot.copilot_code-review_short %} for users without a license. - * This policy is **disabled by default**. - * Once this policy is set at the enterprise level, it becomes **visible (but not editable)** at the organization level. - * The policy is **most restrictive**, meaning {% data variables.copilot.copilot_code-review_short %} is only available in repositories where the policy is explicitly enabled. +The second policy has these characteristics: -When both policies are enabled, users without a {% data variables.product.prodname_copilot_short %} license can request a {% data variables.copilot.copilot_code-review_short %} review on their pull requests in the organization’s repositories. +* It is disabled by default. +* Once this policy is set it at the enterprise level, it becomes **visible, but not editable** at the organization level. +* The policy is **most restrictive**. {% data variables.copilot.copilot_code-review_short %} is only available in repositories where you explicitly enable the policy. -In addition, in repositories where automatic code review is enabled, {% data variables.product.prodname_copilot_short %} automatically reviews all pull requests, regardless of whether the author has a {% data variables.product.prodname_copilot_short %} license. +### How it works for users without a license -{% data variables.copilot.copilot_code-review_short %} for users without a license is **not available in IDEs** or in organizations that do not have these policies enabled. +When both policies are enabled, users without a {% data variables.product.prodname_copilot_short %} license can request a review from {% data variables.copilot.copilot_code-review_short %} on their pull requests in the organization's repositories. + +In repositories where automatic code review is enabled, {% data variables.product.prodname_copilot_short %} automatically reviews all pull requests. This happens regardless of whether the author has a {% data variables.product.prodname_copilot_short %} license. + +{% data variables.copilot.copilot_code-review_short %} for users without a license is not available in IDEs. ## Excluded files -Dependency management files (such as package.json and Gemfile.lock) and certain other types of files (such as log files and SVGs) are excluded from {% data variables.copilot.copilot_code-review_short %}. If you include any of these files in a pull request, {% data variables.copilot.copilot_code-review_short %} will not consider the file when carrying out the review. Similarly, using {% data variables.copilot.copilot_code-review_short %} on one of these files in your IDE, will not generate review comments. +Some file types are excluded from {% data variables.copilot.copilot_code-review_short %}: + +* Dependency management files, such as package.json and Gemfile.lock +* Log files +* SVG files + +If you include these file types in a pull request, {% data variables.copilot.copilot_code-review_short %} will not review the file. For more information, see [AUTOTITLE](/copilot/reference/review-excluded-files). @@ -73,17 +88,17 @@ For more information, see [AUTOTITLE](/copilot/reference/review-excluded-files). > * The [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-pre-release-license-terms) apply to your use of this product. > * {% data variables.copilot.copilot_code-review_short %} has several new tools that are in {% data variables.release-phases.public_preview %} and subject to change. -These new tools are enabled automatically for {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} plans. +If you get a {% data variables.product.prodname_copilot_short %} subscription from an organization, you can only participate in the {% data variables.release-phases.public_preview %} on the {% data variables.product.github %} website if an owner of your organization or enterprise has enabled using preview features. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization) and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies). -If you get a {% data variables.product.prodname_copilot_short %} subscription from an organization, you will only be able to participate in the {% data variables.release-phases.public_preview %} on the {% data variables.product.github %} website if an owner of your organization or enterprise has enabled **{% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %} > Opt in to preview features** in the **{% data variables.product.prodname_copilot %} policies** page of the organization or enterprise settings. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization) and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies). +These new tools are enabled automatically for {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} plans. -* **Full project context gathering** to provide more specific, accurate, and contextually aware code reviews. -* **Support for static analysis tools like {% data variables.product.prodname_codeql %}, ESLint, and PMD** to deliver more high-signal, consistent findings for security and quality. -* **The ability to pass suggestions to {% data variables.copilot.copilot_coding_agent %}**, for automated creation of a new pull request against your branch with the suggested fixes applied. +* **Full project context gathering**. This provides more specific, accurate, and contextually aware code reviews. +* **Support for static analysis tools like {% data variables.product.prodname_codeql %}, ESLint, and PMD**. This delivers more high-signal, consistent findings for security and quality. +* **The ability to pass suggestions to {% data variables.copilot.copilot_coding_agent %}**. This automates creation of a new pull request against your branch with the suggested fixes applied. -You are not required to have {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_actions %} enabled in your organization or enterprise to use the {% data variables.copilot.copilot_code-review-tools_short %}. +You do not need to have {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_actions %} enabled in your organization or enterprise to use the {% data variables.copilot.copilot_code-review-tools_short %}. -In the event that {% data variables.product.prodname_actions %} is unavailable or if Actions workflows used by {% data variables.copilot.copilot_code-review_short %} fail, reviews will still be generated but without the additional features provided by the {% data variables.copilot.copilot_code-review-tools_short %}. +If {% data variables.product.prodname_actions %} is unavailable or if Actions workflows used by {% data variables.copilot.copilot_code-review_short %} fail, reviews will still be generated. However, they will not include the additional features provided by the {% data variables.copilot.copilot_code-review-tools_short %}. > [!NOTE] > @@ -93,17 +108,24 @@ In the event that {% data variables.product.prodname_actions %} is unavailable o ## Code review monthly quota -Each time {% data variables.product.prodname_copilot_short %} reviews a pull request, or reviews code in your IDE, your monthly quota of {% data variables.product.prodname_copilot_short %} premium requests is reduced by one. +Each time {% data variables.product.prodname_copilot_short %} reviews a pull request or reviews code in your IDE, your monthly quota of {% data variables.product.prodname_copilot_short %} premium requests is reduced by one. + +If a repository is configured to automatically request a code review from {% data variables.product.prodname_copilot_short %} for all new pull requests, the premium request usage is applied to the pull request author's quota. + +If a pull request is created by {% data variables.product.prodname_actions %} or by a bot, the usage will apply to: -If a repository is configured to automatically request a code review from {% data variables.product.prodname_copilot_short %} for all new pull requests, the premium request usage is applied to the quota of the pull request author. If a pull request is created by {% data variables.product.prodname_actions %} or by a bot, the usage will apply to the user who triggered the workflow (if identifiable), or to a designated billing owner. +* The user who triggered the workflow, if that user can be identified. +* A designated billing owner. -When you reach your monthly quota you will not be able to get a code review from {% data variables.product.prodname_copilot_short %} until your quota resets—unless you upgrade your {% data variables.product.prodname_copilot_short %} plan or enable additional premium requests. +### What happens when you reach your quota + +When you reach your monthly quota, you will not be able to get a code review from {% data variables.product.prodname_copilot_short %} until your quota resets. To continue to use code reviews before your quota resets, you will need to upgrade your {% data variables.product.prodname_copilot_short %} plan or enable additional premium requests. ### Quota for users without a {% data variables.product.prodname_copilot_short %} license -Users without a {% data variables.product.prodname_copilot_short %} license do not have a monthly premium request quota. When {% data variables.copilot.copilot_code-review_short %} is enabled for these users through the “Allow members without a {% data variables.product.prodname_copilot_short %} license to use {% data variables.copilot.copilot_code-review_short %} in {% data variables.product.prodname_dotcom_the_website %}” policy, any premium requests they generate—either by manually requesting a review or through automatic code review—are billed directly to the organization or enterprise as paid overage usage. +Users without a {% data variables.product.prodname_copilot_short %} license do not have a monthly premium request quota. When {% data variables.copilot.copilot_code-review_short %} is enabled for these users, any premium requests they generate are billed directly to the organization or enterprise as paid overage usage. This applies to both manually requested reviews and automatic code reviews. -Premium requests generated by users without a license are not attributed to any {% data variables.product.prodname_copilot_short %} plan quota and appear as overage usage in billing reports and premium request analytics. Users with a {% data variables.product.prodname_copilot_short %} license continue to consume premium requests from their assigned plan quota. +Premium requests generated by users without a license are not attributed to any {% data variables.product.prodname_copilot_short %} plan quota. They appear as overage usage in billing reports and premium request analytics. Users with a {% data variables.product.prodname_copilot_short %} license continue to consume premium requests from their assigned plan quota. ## Model usage @@ -113,65 +135,60 @@ Premium requests generated by users without a license are not attributed to any ## Validating {% data variables.product.prodname_copilot_short %} code reviews -{% data variables.product.prodname_copilot_short %} isn't guaranteed to spot all problems or issues in a pull request, and sometimes it will make mistakes. Always validate {% data variables.product.prodname_copilot_short %}'s feedback carefully, and supplement {% data variables.product.prodname_copilot_short %}'s feedback with a human review. +{% data variables.product.prodname_copilot_short %} is not guaranteed to spot all problems or issues in a pull request. Sometimes it will make mistakes. Always validate {% data variables.product.prodname_copilot_short %}'s feedback carefully. Supplement {% data variables.product.prodname_copilot_short %}'s feedback with a human review. For more information, see [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-code-review). ## Enhancing {% data variables.product.prodname_copilot_short %}'s knowledge of a repository -The more {% data variables.product.prodname_copilot_short %} knows about the code in your repository, the tools you use, and your coding standards and practices, the more accurate and useful its reviews will become. There are two ways you can enhance {% data variables.product.prodname_copilot_short %}'s knowledge of your repositories. +The more {% data variables.product.prodname_copilot_short %} knows about the code in your repository, the tools you use, and your coding standards and practices, the more accurate and useful its reviews will become. You can enhance {% data variables.product.prodname_copilot_short %}'s knowledge of your repositories in two ways. -* **Custom instructions** +### Custom instructions - These are short, natural‑language statements that you write and store as one or more files in a repository. If you are the owner of an organization on {% data variables.product.github %} you can also define custom instructions in the settings for your organization. For more information, see [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=webui#about-repository-custom-instructions). +These are short, natural-language statements that you write and store as one or more files in a repository. If you are the owner of an organization on {% data variables.product.github %}, you can also define custom instructions in the settings for your organization. For more information, see [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=webui#about-repository-custom-instructions). -* **{% data variables.copilot.copilot_memory %}** ({% data variables.release-phases.public_preview %}) +### {% data variables.copilot.copilot_memory %} ({% data variables.release-phases.public_preview %}) - If you have a {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} plan, you can enable {% data variables.copilot.copilot_memory %}. This allows {% data variables.product.prodname_copilot_short %} to store useful details it has worked out for itself about a repository. {% data variables.product.prodname_copilot_short %} can then use this information when it is reviewing pull requests in that repository. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-memory). +If you have a {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} plan, you can enable {% data variables.copilot.copilot_memory %}. This allows {% data variables.product.prodname_copilot_short %} to store useful details it has learned about a repository. {% data variables.product.prodname_copilot_short %} can then use this information when it reviews pull requests in that repository. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-memory). ## About automatic pull request reviews -By default, {% data variables.product.prodname_copilot_short %} will only review a pull request if it's assigned to the pull request in the same way you would assign a human reviewer. However: +By default, {% data variables.product.prodname_copilot_short %} only reviews a pull request if you assign it to the pull request. However, you can configure automatic reviews. -* Individual users on the {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} plan can configure {% data variables.product.prodname_copilot_short %} to automatically review all pull requests they create. -* Repository owners can configure {% data variables.product.prodname_copilot_short %} to automatically review all pull requests in the repository that are created by people with access to {% data variables.product.prodname_copilot_short %}. -* Organization owners can configure {% data variables.product.prodname_copilot_short %} to automatically review all pull requests in some or all of the repositories in the organization where the pull request is created by a {% data variables.product.prodname_copilot_short %} user. +* **Individual users** on the {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} plan can configure {% data variables.product.prodname_copilot_short %} to automatically review all pull requests they create. +* **Repository owners** can configure {% data variables.product.prodname_copilot_short %} to automatically review all pull requests in the repository that are created by people with access to {% data variables.product.prodname_copilot_short %}. +* **Organization owners** can configure {% data variables.product.prodname_copilot_short %} to automatically review all pull requests in some or all of the repositories in the organization where the pull request is created by a {% data variables.product.prodname_copilot_short %} user. ### Triggering an automatic pull request review -The triggers for automatic code review depend on the configuration settings: - -* **Basic setting**: - * When a pull request is created as an "Open" pull request. - * The first time a "Draft" pull request is switched to "Open". -* **Review new pushes**: - * Every time a new commit is pushed to the pull request. -* **Review draft pull requests**: - * Pull requests are automatically reviewed while they are still drafts—before being switched to "Open". +The triggers for automatic code review depend on the configuration settings. -> [!NOTE] -> Unless {% data variables.product.prodname_copilot_short %} has been configured to review each push to a pull request, it will only review the pull request once. If you make changes to the pull request after it has been automatically reviewed and you want {% data variables.product.prodname_copilot_short %} to re-review the pull request, you can request this manually. To do this, click the {% octicon "sync" aria-label="Re-request review" %} button next to {% data variables.product.prodname_copilot_short %}'s name in the **Reviewers** menu. - -### Limits on automatic pull request reviews - -{% data variables.copilot.copilot_code-review_short %} is a premium feature with a per-person monthly quota. When {% data variables.product.prodname_copilot_short %} carries out an automatic review, it uses one premium request from the quota of the user who created the pull request. For more information, see [AUTOTITLE](/copilot/concepts/agents/code-review#code-review-monthly-quota). +* Basic setting: + * When you create a pull request as an "Open" pull request. + * The first time you switch a "Draft" pull request to "Open". +* Review new pushes: + * Every time you push a new commit to the pull request. +* Review draft pull requests: + * Pull requests are automatically reviewed while they are still drafts, before you switch them to "Open". -## Configuring automatic pull request reviews +For full instructions, see [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/configuring-automatic-code-review-by-copilot). -For details of how to configure {% data variables.product.prodname_copilot_short %} to automatically review new pull requests, see [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/configuring-automatic-code-review-by-copilot). +> [!NOTE] +> Unless {% data variables.product.prodname_copilot_short %} has been configured to review each push to a pull request, it will only review a pull request once. If you make changes to the pull request after it has been automatically reviewed and you want {% data variables.product.prodname_copilot_short %} to re-review it, you can request this manually. Click the {% octicon "sync" aria-label="Re-request review" %} button next to {% data variables.product.prodname_copilot_short %}'s name in the **Reviewers** menu. ## About static analysis tools -You can enable static analysis tools in {% data variables.copilot.copilot_code-review_short %} to enhance its ability to identify and fix issues. Available tools include: +Enable static analysis tools in {% data variables.copilot.copilot_code-review_short %} to enhance its ability to identify and fix issues. Available tools include: + * **{% data variables.product.prodname_codeql %}**: A code analysis engine that identifies security vulnerabilities. For more information, see [About {% data variables.product.prodname_codeql %}](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql#about-codeql). -* **ESLint**: A linter designed specifically for JavaScript. For more information, see [Core Concepts](https://eslint.org/docs/latest/use/core-concepts/) in the the ESLint documentation. -* **PMD**: A static code analyzer that focuses on Java and Apex, but also supports many other languages. For more information, see the [PMD documentation](https://docs.pmd-code.org/latest/). +* **ESLint**: A linter designed specifically for JavaScript. See [Core Concepts](https://eslint.org/docs/latest/use/core-concepts/) in the the ESLint documentation. +* **PMD**: A static code analyzer that focuses on Java and Apex. It also supports many other languages. See the [PMD documentation](https://docs.pmd-code.org/latest/). -If you have access to {% data variables.copilot.copilot_code-review-tools_short %}, {% data variables.product.prodname_codeql %} is enabled by default, while ESLint and PMD are disabled. Additionally, if you have access to rulesets, you can change your selected tools. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/request-a-code-review/manage-tools). +If you have access to {% data variables.copilot.copilot_code-review-tools_short %}, {% data variables.product.prodname_codeql %} is enabled by default. ESLint and PMD are disabled. If you have access to rulesets, you can change your selected tools. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/request-a-code-review/manage-tools). ## Getting detailed code quality feedback for your whole repository -{% data variables.copilot.copilot_code-review %} reviews your code in pull requests and provides feedback. If you want to surface actionable feedback on the reliability and maintainability of your whole repository, enable {% data variables.product.prodname_code_quality %}. See [AUTOTITLE](/code-security/code-quality/concepts/about-code-quality). +{% data variables.copilot.copilot_code-review %} reviews your code in pull requests and provides feedback. If you want actionable feedback on the reliability and maintainability of your whole repository, enable {% data variables.product.prodname_code_quality %}. See [AUTOTITLE](/code-security/code-quality/concepts/about-code-quality). ## Further reading diff --git a/content/copilot/how-tos/configure-custom-instructions/add-personal-instructions.md b/content/copilot/how-tos/configure-custom-instructions/add-personal-instructions.md index fcf188eec351..bf666e075ae2 100644 --- a/content/copilot/how-tos/configure-custom-instructions/add-personal-instructions.md +++ b/content/copilot/how-tos/configure-custom-instructions/add-personal-instructions.md @@ -17,13 +17,16 @@ category: {% data reusables.copilot.personal-instructions-note %} -For an overview of the methods you can use to customize {% data variables.copilot.copilot_chat %} responses, see [AUTOTITLE](/copilot/concepts/about-customizing-github-copilot-chat-responses?tool=webui). +You can customize {% data variables.copilot.copilot_chat %} responses in several ways. For an overview, see [AUTOTITLE](/copilot/concepts/about-customizing-github-copilot-chat-responses?tool=webui). -## About personal custom instructions for {% data variables.copilot.copilot_chat %} +## About personal custom instructions for {% data variables.copilot.copilot_chat_short %} + +Add custom instructions to receive personalized chat responses. Your instructions apply to all your conversations on the {% data variables.product.github %} website. Custom instructions let you specify preferences such as your preferred language or response style. + +Examples of instructions you can add: -You can add custom instructions for {% data variables.copilot.copilot_chat %} in order to receive chat responses that are customized to your personal preferences, across your conversations on the {% data variables.product.github %} website. For example, you can choose to always have {% data variables.copilot.copilot_chat_short %} respond in a preferred language or with a particular style. Some examples of instructions you could add are: * `Always respond in Spanish.` -* `Your style is a helpful colleague, minimize explanations but provide enough context to understand the code.` +* `Use a helpful, collegial tone. Keep explanations brief, but provide enough context to understand the code.` * `Always provide examples in TypeScript.` > [!NOTE] @@ -32,15 +35,20 @@ You can add custom instructions for {% data variables.copilot.copilot_chat %} in ## Adding personal custom instructions -You can add personal custom instructions in {% data variables.copilot.copilot_chat_short %} in {% data variables.product.github %}. +To add personal custom instructions in {% data variables.copilot.copilot_chat_short %} on {% data variables.product.github %}: 1. Open [{% data variables.copilot.copilot_chat_short %}](https://github.com/copilot?ref_product=copilot&ref_type=engagement&ref_style=text). -1. In the bottom left corner, click your profile picture, then click **{% octicon "note" aria-hidden="true" aria-label="note" %} Personal instructions**. +1. In the bottom left corner, click your profile picture. Then click **{% octicon "note" aria-hidden="true" aria-label="note" %} Personal instructions**. 1. Add natural language instructions to the text box. + + Use any format. For example, a single block of text, each instruction on a new line, or instructions separated by blank lines. + +1. Optionally, use a template for common instructions. Click {% octicon "light-bulb" aria-label="The light-bulb icon" %} and select a template. + + When you select a template, placeholder text appears. Replace placeholders like `{format}` with your preferences. +1. Click **Save**. - You can write your instructions in any format you prefer. For example, you can write them as a single block of text, each on a new line, or separated by blank lines. -1. Optionally, click {% octicon "light-bulb" aria-label="The light-bulb icon" %} to view templates you can use for common instructions. If you click on one of the boxes, such as "Communication", instructions will be added to the text box with placeholders, such as `{format}` that you can replace with your preferences. -1. Click **Save**. Your instructions are now active, and will stay active until you change or remove them. +Your instructions are now active. They will remain active until you change or remove them. {% note %} diff --git a/content/copilot/tutorials/speed-up-development-work.md b/content/copilot/tutorials/speed-up-development-work.md index 613c5f0b1750..57d79ef25d57 100644 --- a/content/copilot/tutorials/speed-up-development-work.md +++ b/content/copilot/tutorials/speed-up-development-work.md @@ -16,22 +16,26 @@ category: - Author and optimize with Copilot --- -If you're starting a new feature, trying to understand a system, or picking up a task in a codebase you’re still learning, {% data variables.copilot.copilot_spaces %} can help you: +{% data variables.copilot.copilot_spaces %} helps you work faster when starting a new feature, understanding a system, or picking up a task in an unfamiliar codebase. -* Stay focused by organizing the context you need in one place. -* Get better help from {% data variables.product.prodname_copilot_short %} by grounding it in relevant code and documentation. -* Move faster without switching between tools or asking others for background information. +Use {% data variables.copilot.copilot_spaces_short %} to: + +* Organize the context you need in one place. +* Provide {% data variables.product.prodname_copilot_short %} with relevant code and documentation. +* Reduce time spent switching between tools or asking others for background information. To create a space, go to [https://github.com/copilot/spaces](https://github.com/copilot/spaces?ref_product=copilot&ref_type=engagement&ref_style=text), and click **Create space**. -Below are some examples of how to use {% data variables.copilot.copilot_spaces_short %} to help you with development work. +The examples in this article show you how to use {% data variables.copilot.copilot_spaces_short %} for common development tasks. ## Developing a new feature -When working on a specific feature, you can save time and produce higher-quality results by using a space. Add the relevant code, a product spec, and any supporting materials—like notes from a design review or mockup images. {% data variables.product.prodname_copilot_short %} can help you: +Create a space when you start working on a specific feature. Add the relevant code, a product specification, and any supporting materials. Supporting materials can include notes from a design review or mockup images. + +{% data variables.product.prodname_copilot_short %} can help you: * Summarize how the current implementation works. -* Suggest changes or additions based on the spec. +* Suggest changes or additions based on the specification. * Draft a first implementation or outline next steps. * Flag missing elements or inconsistencies. @@ -43,12 +47,14 @@ When working on a specific feature, you can save time and produce higher-quality ## Defining the logic for a small, frequent task -When working on repetitive tasks like tracking telemetry events or handling event emissions, it’s useful to document the logic once and share it with others through {% data variables.copilot.copilot_spaces_short %}. This allows everyone to stay consistent and saves time when performing the task. If you have a process flowchart for a task, you can upload this to your space for reference. {% data variables.product.prodname_copilot_short %} can assist by: +Document the logic for repetitive tasks once and share it through a space. This approach keeps everyone consistent and saves time. Tasks like tracking telemetry events or handling event emissions benefit from this approach. + +If you have a process flowchart, upload it to your space for reference. {% data variables.product.prodname_copilot_short %} can: -* Suggesting efficient patterns based on your previous work. -* Helping write reusable functions or templates. -* Reviewing the logic to ensure it aligns with project standards. -* Providing examples of how similar tasks have been handled in the codebase. +* Suggest efficient patterns based on your previous work. +* Help write reusable functions or templates. +* Review the logic to ensure it aligns with project standards. +* Provide examples of how similar tasks have been handled in the codebase. **Instructions**: > You help developers implement telemetry events. You should (1) validate what the user's goals are for the event, (2) propose a new event structure based on examples of existing events (and using the common telemetry schema), and (3) create a new version of the telemetry config file. @@ -58,11 +64,13 @@ When working on repetitive tasks like tracking telemetry events or handling even ## Sharing knowledge with teammates -In situations where people tend to ask similar questions, such as how authentication or search works in your project, {% data variables.product.prodname_copilot_short %} can help: +Create a space for topics where people tend to ask similar questions. For example, questions about how authentication or search works in your project. + +{% data variables.product.prodname_copilot_short %} can: * Explain how the code works. -* Answer questions grounded in the latest documentation. -* Guide new team members on the best practices. +* Answer questions based on the latest documentation. +* Guide new team members on best practices. **Instructions**: > You contain the code and documentation associated with our authentication system. @@ -72,16 +80,17 @@ In situations where people tend to ask similar questions, such as how authentica ## Hands-on practice -Try the [Scale institutional knowledge using Copilot Spaces](https://github.com/skills/scale-institutional-knowledge-using-copilot-spaces) Skills exercise for practical experience to do the following: -* Centralize scattered project management knowledge in Copilot Spaces -* Convert tacit team insights into searchable, versioned artifacts -* Give all team members equal access to processes, decisions, and rationale -* Connect a repository as a structured knowledge source -* Extract, refine, and standardize workflows collaboratively -* Feed validated improvements back into living documentation -* Accelerate onboarding and reduce single-person dependency risk -* Enable consistent, repeatable project execution +Try the [Scale institutional knowledge using Copilot Spaces](https://github.com/skills/scale-institutional-knowledge-using-copilot-spaces) Skills exercise for practical experience. This exercise shows you how to: + +* Centralize scattered project management knowledge in Copilot Spaces. +* Convert team insights into searchable, versioned artifacts. +* Give all team members equal access to processes, decisions, and rationale. +* Connect a repository as a structured knowledge source. +* Extract, refine, and standardize workflows collaboratively. +* Feed validated improvements back into living documentation. +* Accelerate onboarding and reduce single-person dependency risk. +* Enable consistent, repeatable project execution. ## Next steps -Once you’ve created a space to help with development tasks, consider sharing it with your team to reduce handoffs and repeated questions. See [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/collaborating-with-your-team-using-copilot-spaces). +After you create a space to help with development tasks, consider sharing it with your team to reduce handoffs and repeated questions. See [AUTOTITLE](/copilot/using-github-copilot/copilot-spaces/collaborating-with-your-team-using-copilot-spaces). diff --git a/content/repositories/creating-and-managing-repositories/deleting-a-repository.md b/content/repositories/creating-and-managing-repositories/deleting-a-repository.md index 4ae04495d95c..7e172dd88ad5 100644 --- a/content/repositories/creating-and-managing-repositories/deleting-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/deleting-a-repository.md @@ -20,7 +20,7 @@ topics: Deleting a public repository will not delete any forks of the repository. > [!WARNING] -> * Deleting a repository will **permanently** delete release attachments and team permissions. This action **cannot** be undone. +> * Deleting a repository will **permanently** delete team permissions. This action **cannot** be undone. > * Deleting a private{% ifversion ghes or ghec %} or internal{% endif %} repository will delete all forks of the repository. Some deleted repositories can be restored within 90 days of deletion. {% ifversion ghes %}Your site administrator may be able to restore a deleted repository for you. For more information, see [AUTOTITLE](/admin/user-management/managing-repositories-in-your-enterprise/restoring-a-deleted-repository). {% else %}For more information, see [AUTOTITLE](/repositories/creating-and-managing-repositories/restoring-a-deleted-repository).{% endif %} diff --git a/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md b/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md index 55b03b13a75c..6c08a3cbcc84 100644 --- a/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md +++ b/content/repositories/creating-and-managing-repositories/restoring-a-deleted-repository.md @@ -36,7 +36,7 @@ If you want to restore a repository that was part of a fork network that is not It can take up to an hour after a repository is deleted before that repository is available for restoration. -Restoring a repository will not restore release attachments or team permissions. Issues that are restored will not be labeled. +Restoring a repository will not restore team permissions. Issues that are restored will not be labeled. ## Restoring a deleted repository that was owned by a personal account diff --git a/data/reusables/copilot/custom-instructions-chat-precedence.md b/data/reusables/copilot/custom-instructions-chat-precedence.md index 5fccbb7d86dc..cfd7c93fc79f 100644 --- a/data/reusables/copilot/custom-instructions-chat-precedence.md +++ b/data/reusables/copilot/custom-instructions-chat-precedence.md @@ -1 +1 @@ -Multiple types of custom instructions can apply to a request sent to {% data variables.product.prodname_copilot_short %}. Personal instructions take the highest priority, followed by repository instructions, with organization instructions prioritized last. However, all sets of relevant instructions are still combined and provided to {% data variables.product.prodname_copilot_short %}. +Multiple types of custom instructions can apply to a request sent to {% data variables.product.prodname_copilot_short %}. Personal instructions take the highest priority. Repository instructions come next, and then organization instructions are prioritized last. However, all sets of relevant instructions are provided to {% data variables.product.prodname_copilot_short %}. diff --git a/data/reusables/copilot/custom-instructions-conflict.md b/data/reusables/copilot/custom-instructions-conflict.md index 197e94373be4..3a930373f6e5 100644 --- a/data/reusables/copilot/custom-instructions-conflict.md +++ b/data/reusables/copilot/custom-instructions-conflict.md @@ -1 +1 @@ -Whenever possible, you should avoid providing conflicting sets of instructions. If you are concerned about response quality, you can also choose to temporarily disable repository instructions. See [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot?tool=webui#enabling-or-disabling-repository-custom-instructions). +Whenever possible, try to avoid providing conflicting sets of instructions. If you are concerned about response quality, you can temporarily disable repository instructions. See [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot?tool=webui#enabling-or-disabling-repository-custom-instructions). diff --git a/data/reusables/copilot/personal-instructions-note.md b/data/reusables/copilot/personal-instructions-note.md index 3e6ccde45e6e..833aeb379e95 100644 --- a/data/reusables/copilot/personal-instructions-note.md +++ b/data/reusables/copilot/personal-instructions-note.md @@ -1 +1 @@ -> [!NOTE] Personal custom instructions are currently only supported for {% data variables.copilot.copilot_chat_dotcom %}. +> [!NOTE] Personal custom instructions are only supported for {% data variables.copilot.copilot_chat_dotcom %}.