Merge pull request #39696 from github/repo-sync

Repo sync

Author: docs-bot

Dockerfile

@@ -8,7 +8,7 @@
 # ---------------------------------------------------------------
 # To update the sha:
 # https://github.com/github/gh-base-image/pkgs/container/gh-base-image%2Fgh-base-noble
-FROM ghcr.io/github/gh-base-image/gh-base-noble:20250730-174526-g48ad667e7 AS base
+FROM ghcr.io/github/gh-base-image/gh-base-noble:20250805-204228-g50c20871f AS base
 
 # Install curl for Node install and determining the early access branch
 # Install git for cloning docs-early-access & translations repos

content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md

@@ -16,8 +16,6 @@ contentType: how-tos
 
 {% webui %}
 
-> [!NOTE] This feature is currently in {% data variables.release-phases.public_preview %} and is subject to change.
-
 This version of this article is for using repository custom instructions on the {% data variables.product.github %} website. Click the tabs above for information on using custom instructions in other environments. <!-- markdownlint-disable-line MD027 -->
 
 {% endwebui %}
@@ -36,16 +34,12 @@ This version of this article is for using repository custom instructions in {% d
 
 {% jetbrains %}
 
-> [!NOTE] This feature is currently in {% data variables.release-phases.public_preview %} and is subject to change.
-
 This version of this article is for using repository custom instructions in JetBrains IDEs. Click the tabs above for instructions on using custom instructions in other environments.
 
 {% endjetbrains %}
 
 {% xcode %}
 
-> [!NOTE] This feature is currently in {% data variables.release-phases.public_preview %} and is subject to change.
-
 This version of this article is for using repository custom instructions in Xcode. Click the tabs above for instructions on using custom instructions in other environments.
 
 {% endxcode %}
@@ -64,8 +58,6 @@ Repository custom instructions let you provide {% data variables.product.prodnam
 
 * Your personal choice of whether to use custom instructions must be set to enabled. This is enabled by default. See [Enabling or disabling repository custom instructions](#enabling-or-disabling-repository-custom-instructions) later in this article.
 
-* During the {% data variables.release-phases.public_preview %}, if you're using a {% data variables.copilot.copilot_business_short %} {% ifversion ghec %}or {% data variables.copilot.copilot_enterprise_short %}{% endif %} plan, the organization {% ifversion ghec %}or enterprise{% endif %} that provides your plan must have the **Opt in to preview features** setting enabled. See [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization){% ifversion ghec %} and [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#copilot-in-githubcom){% endif %}.
-
 {% endwebui %}
 
 {% vscode %}
@@ -76,7 +68,7 @@ Repository custom instructions let you provide {% data variables.product.prodnam
 
 {% visualstudio %}
 
-* The **Enable custom instructions** option must be enabled in your settings. This is enabled by default. See [Enabling or disabling repository custom instructions](#enabling-or-disabling-repository-custom-instructions) later in this article.
+* The **Enable custom instructions...** option must be enabled in your settings. This is enabled by default. See [Enabling or disabling repository custom instructions](#enabling-or-disabling-repository-custom-instructions) later in this article.
 
 {% endvisualstudio %}
 
@@ -206,12 +198,108 @@ Whitespace between instructions is ignored, so the instructions can be written a
 
 {% webui %}
 
-**{% data variables.copilot.copilot_chat_short %}** on the {% data variables.product.github %} website and **{% data variables.copilot.copilot_code-review_short %}** support a single `.github/copilot-instructions.md` custom instructions file stored in the repository.
+**{% data variables.copilot.copilot_chat_short %}** on the {% data variables.product.github %} website, **{% data variables.copilot.copilot_coding_agent %}** and **{% data variables.copilot.copilot_code-review_short %}** support a single `.github/copilot-instructions.md` custom instructions file stored in the repository.
 
 In addition, **{% data variables.copilot.copilot_coding_agent %}** supports one or more `.instructions.md` files stored within `.github/instructions` in the repository. Each file can specify `applyTo` frontmatter to define what files or directories its instructions apply to.
 
 ### Using a single `.github/copilot-instructions.md` file
 
+You can ask {% data variables.copilot.copilot_coding_agent %} to generate a `.github/copilot-instructions.md` file, or you can write your own instructions file.
+
+#### Asking {% data variables.copilot.copilot_coding_agent %} to generate a `.github/copilot-instructions.md` file
+
+> [!NOTE]
+> {% data reusables.copilot.coding-agent.preview-note-text %}
+
+1. Navigate to the Agents page at [github.com/copilot/agents](https://github.com/copilot/agents).
+
+    You can also reach this page by clicking the **{% octicon "copilot" aria-label="Copilot icon" %}** button next to the search bar on any page on {% data variables.product.github %}, then selecting **Agents** from the sidebar.
+
+1. Using the dropdown menu in the prompt field, select the repository you want {% data variables.product.prodname_copilot_short %} to generate custom instructions for.
+
+1. Copy the following prompt, customizing it if needed:
+
+   ```markdown copy
+   Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently.
+
+   You will do this task only one time per repository and doing a good job can SIGNIFICANTLY improve the quality of the agent's work, so take your time, think carefully, and search thoroughly before writing the instructions.
+
+   <Goals>
+   - Reduce the likelihood of a coding agent pull request getting rejected by the user due to
+   generating code that fails the continuous integration build, fails a validation pipeline, or
+   having misbehavior.
+   - Minimize bash command and build failures.
+   - Allow the agent to complete its task more quickly by minimizing the need for exploration using grep, find, str_replace_editor, and code search tools.
+   </Goals>
+
+   <Limitations>
+   - Instructions must be no longer than 2 pages.
+   - Instructions must not be task specific.
+   </Limitations>
+
+   <WhatToAdd>
+
+   Add the following high level details about the codebase to reduce the amount of searching the agent has to do to understand the codebase each time:
+   <HighLevelDetails>
+
+   - A summary of what the repository does.
+   - High level repository information, such as the size of the repo, the type of the project, the languages, frameworks, or target runtimes in use.
+   </HighLevelDetails>
+
+   Add information about how to build and validate changes so the agent does not need to search and find it each time.
+   <BuildInstructions>
+
+   - For each of bootstrap, build, test, run, lint, and any other scripted step, document the sequence of steps to take to run it successfully as well as the versions of any runtime or build tools used.
+   - Each command should be validated by running it to ensure that it works correctly as well as any preconditions and postconditions.
+   - Try cleaning the repo and environment and running commands in different orders and document errors and and misbehavior observed as well as any steps used to mitigate the problem.
+   - Run the tests and document the order of steps required to run the tests.
+   - Make a change to the codebase. Document any unexpected build issues as well as the workarounds.
+   - Document environment setup steps that seem optional but that you have validated are actually required.
+   - Document the time required for commands that failed due to timing out.
+   - When you find a sequence of commands that work for a particular purpose, document them in detail.
+   - Use language to indicate when something should always be done. For example: "always run npm install before building".
+   - Record any validation steps from documentation.
+   </BuildInstructions>
+
+   List key facts about the layout and architecture of the codebase to help the agent find where to make changes with minimal searching.
+   <ProjectLayout>
+
+   - A description of the major architectural elements of the project, including the relative paths to the main project files, the location
+   of configuration files for linting, compilation, testing, and preferences.
+   - A description of the checks run prior to check in, including any GitHub workflows, continuous integration builds, or other validation pipelines.
+   - Document the steps so that the agent can replicate these itself.
+   - Any explicit validation steps that the agent can consider to have further confidence in its changes.
+   - Dependencies that aren't obvious from the layout or file structure.
+   - Finally, fill in any remaining space with detailed lists of the following, in order of priority: the list of files in the repo root, the
+   contents of the README, the contents of any key source files, the list of files in the next level down of directories, giving priority to the more structurally important and snippets of code from key source files, such as the one containing the main method.
+   </ProjectLayout>
+   </WhatToAdd>
+
+   <StepsToFollow>
+   - Perform a comprehensive inventory of the codebase. Search for and view:
+   - README.md, CONTRIBUTING.md, and all other documentation files.
+   - Search the codebase for build steps and indications of workarounds like 'HACK', 'TODO', etc.
+   - All scripts, particularly those pertaining to build and repo or environment setup.
+   - All build and actions pipelines.
+   - All project files.
+   - All configuration and linting files.
+   - For each file:
+   - think: are the contents or the existence of the file information that the coding agent will need to implement, build, test, validate, or demo a code change?
+   - If yes:
+      - Document the command or information in detail.
+      - Explicitly indicate which commands work and which do not and the order in which commands should be run.
+      - Document any errors encountered as well as the steps taken to workaround them.
+   - Document any other steps or information that the agent can use to reduce time spent exploring or trying and failing to run bash commands.
+   - Finally, explicitly instruct the agent to trust the instructions and only perform a search if the information in the instructions is incomplete or found to be in error.
+   </StepsToFollow>
+      - Document any errors encountered as well as the steps taken to work-around them.
+
+1. Click **Send now** or press <kbd>Return</kbd>.
+
+{% data variables.product.prodname_copilot_short %} will start a new session, which will appear in the list below the prompt box. {% data variables.product.prodname_copilot_short %} will create a draft pull request, write your custom instructions, push them to the branch, then add you as a reviewer when it has finished, triggering a notification.
+
+#### Writing your own `.github/copilot-instructions.md` file
+
 1. In the root of your repository, create a file named `.github/copilot-instructions.md`.
 
    Create the `.github` directory if it does not already exist.
@@ -220,6 +308,9 @@ In addition, **{% data variables.copilot.copilot_coding_agent %}** supports one
 
    Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility.
 
+> [!TIP]
+> The first time you create a pull request in a given repository with {% data variables.copilot.copilot_coding_agent %}, {% data variables.product.prodname_copilot_short %} will leave a comment with a link to automatically generate custom instructions for the repository.
+
 ### Using one or more `.instructions.md` files
 
 1. Create the `.github/instructions` directory if it does not already exist.
@@ -397,7 +488,7 @@ Your choice persists, for all repositories containing a custom instructions file
    ![Screenshot of the {% data variables.product.prodname_vs %} menu bar. The "Tools" menu is expanded, and the "Options" item is highlighted with an orange outline.](/assets/images/help/copilot/vs-toolbar-options.png)
 
 1. In the "Options" dialog, type `custom instructions` in the search box, then click **{% data variables.product.prodname_copilot_short %}**.
-1. Select or clear the checkbox for **(Preview) Enable custom instructions to be loaded from .github/copilot-instructions.md files and added to requests**.
+1. Select or clear the checkbox for **Enable custom instructions to be loaded from .github/copilot-instructions.md files and added to requests**.
 
 {% data reusables.copilot.custom-instructions-enabling-for-ccr %}
 

content/copilot/tutorials/coding-agent/get-the-best-results.md

@@ -79,7 +79,9 @@ If {% data variables.product.prodname_copilot_short %} is able to build, test an
 
 You can add instructions in a single `.github/copilot-instructions.md` file in the repository, or create one or more `.github/instructions/**/*.instructions.md` files applying to different files or directories in your repository. For more information, see [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot?tool=webui).
 
-Here is an example of an effective `copilot-instructions.md` file:
+The first time you ask {% data variables.product.prodname_copilot_short %} to create a pull request in a given repository, {% data variables.product.prodname_copilot_short %} will leave a comment with a link to automatically generate custom instructions. You can also ask {% data variables.product.prodname_copilot_short %} to generate custom instructions for you at any time using our recommended prompt. See [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions?tool=webui#asking-copilot-coding-agent-to-generate-a-githubcopilot-instructionsmd-file).
+
+You can also choose to write your own custom instructions at any time. Here is an example of an effective `copilot-instructions.md` file:
 
 ```markdown
 This is a Go based repository with a Ruby client for certain API endpoints. It is primarily responsible for ingesting metered usage for GitHub and recording that usage. Please follow these guidelines when contributing:

content/site-policy/github-terms/github-pre-release-license-terms.md

@@ -26,7 +26,7 @@ These terms apply to the pre-release software made available to you by GitHub. T
 
 ## 2. Installation and Use Rights.
 
-  a. **General**. GitHub grants you a limited right to use a non-production instance of the software. You may use any number of copies of the software to develop and test your applications, including deployment within your internal corporate network. You may also use the software in demonstrating your applications.
+  a. **General**. GitHub grants you a limited right to use a non-production instance of the software for evaluation and testing. This means you may use any number of copies of the software to evaluate its functionality and internally develop and test your applications, including deployment of the software within your internal corporate network for evaluation but not external distribution. You may also use the software in internally demonstrating your applications, but may not use the pre-release software in any active production environment, including any use to process live customer data.
 
   b. **Inclusion of Third-Party Components.** The software may include third-party components with separate legal notices or governed by other agreements, as may be described in a license file accompanying the software.
 

data/reusables/copilot/code-review/custom-instructions-information.md

@@ -1,8 +1,3 @@
-> [!NOTE]
-> Custom instructions for {% data variables.copilot.copilot_code-review_short %} are in {% data variables.release-phases.public_preview %} and are subject to change.
->
-> During the {% data variables.release-phases.public_preview %}, if you're using a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plan, the organization or enterprise that provides your plan must have the **Opt in to preview features** setting enabled. See [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization) or [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#copilot-in-githubcom)
-
 You can customize {% data variables.copilot.copilot_code-review_short %} by adding a `.github/copilot-instructions.md` file in your repository containing information that you want {% data variables.product.prodname_copilot_short %} to consider when reviewing code. This is the same `copilot-instructions.md` used by {% data variables.copilot.copilot_chat_short %}. See [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot).
 
 ### Example

src/ghes-releases/lib/enterprise-dates.json

@@ -153,7 +153,7 @@
   },
   "3.14": {
     "releaseDate": "2024-08-06",
-    "deprecationDate": "2025-08-27"
+    "deprecationDate": "2026-01-27"
   },
   "3.15": {
     "releaseDate": "2024-11-12",
@@ -191,4 +191,4 @@
     "releaseDate": "2026-11-10",
     "deprecationDate": "2027-12-08"
   }
-}
+}