Skip to content

Commit 0c39579

Browse files
authored
Merge pull request #41007 from github/repo-sync
Repo sync
2 parents 6ee2b15 + fcf3904 commit 0c39579

File tree

10 files changed

+251
-242
lines changed

10 files changed

+251
-242
lines changed

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Docs changelog
22

3+
**24 October 2025**
4+
5+
To support the enterprise roles and teams public preview, we:
6+
7+
* Created a new concepts category in the [enterprise admin](https://docs.github.com/en/enterprise-cloud@latest/admin) docs aimed at onboarding administrators, including new articles on roles and teams in an enterprise.
8+
* Built a user journey for setting up roles, teams, and apps to simplify administration, starting with [Identifying the roles required by your enterprise](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-roles-in-your-enterprise/identify-role-requirements).
9+
* Published how-to content on [creating custom roles](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-roles-in-your-enterprise/create-custom-roles), [creating enterprise teams](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/create-enterprise-teams), and [assigning roles](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-roles-in-your-enterprise/assign-roles).
10+
* Communicated new conceptual frameworks and best practices for enterprise accounts, including [Best practices for organizing work in your enterprise](https://docs.github.com/en/enterprise-cloud@latest/admin/concepts/best-practices) and [Enterprise accounts](https://docs.github.com/en/enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/enterprise-accounts).
11+
12+
<hr>
13+
314
**17 October 2025**
415

516
We have updated the [Account and profile](https://docs.github.com/en/account-and-profile) and [Subscriptions and notifications](https://docs.github.com/en/subscriptions-and-notifications) docs for improved usability, scannability, and information architecture.

content/admin/managing-accounts-and-repositories/managing-roles-in-your-enterprise/abilities-of-roles.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ redirect_from:
1111
- /admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise
1212
- /admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/roles-in-an-enterprise
1313
- /admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/abilities-of-roles
14+
- /early-access/enterprise/enterprise-roles/enterprise-security-manager
1415
versions:
1516
ghec: '*'
1617
ghes: '*'
@@ -93,7 +94,7 @@ App managers can also be assigned to individual apps. See [AUTOTITLE](/admin/man
9394
## Security managers
9495

9596
> [!NOTE]
96-
> The enterprise security manager role is in {% data variables.release-phases.public_preview %} and subject to change. The [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-pre-release-license-terms) apply to your use of this role.
97+
> The enterprise security manager role is in {% data variables.release-phases.public_preview %} and subject to change.
9798
9899
Security managers have the permissions required to effectively manage use of security features and alerts for the enterprise. They can view, manage, and assign:
99100

content/copilot/concepts/prompting/response-customization.md

Lines changed: 154 additions & 141 deletions
Large diffs are not rendered by default.

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

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -15,28 +15,9 @@ redirect_from:
1515
contentType: how-tos
1616
---
1717

18-
> [!NOTE]
19-
> This feature is currently in {% data variables.release-phases.public_preview %} and is subject to change.
20-
>
21-
> **Support:** Organization custom instructions are currently only supported for {% data variables.copilot.copilot_chat_short %} on {% data variables.product.prodname_dotcom_the_website %} and {% data variables.copilot.copilot_code-review_short %} on {% data variables.product.prodname_dotcom_the_website %}.
18+
{% data reusables.copilot.custom-instructions-org-support %}
2219

23-
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).
24-
25-
## About organization custom instructions for {% data variables.product.prodname_copilot_short %}
26-
27-
Organization owners can add instructions for {% data variables.product.prodname_copilot_short %}, to tailor responses to the needs and preferences of your organization. For example, you can choose to always have {% data variables.copilot.copilot_chat_short %} respond in your company's language of choice or with a particular style.
28-
29-
Custom instructions defined in an organization's {% data variables.product.prodname_copilot_short %} settings are used for all members of the organization, irrespective of whether they receive their {% data variables.product.prodname_copilot_short %} subscription from that organization.
30-
31-
Some examples of instructions you could add are:
32-
* `Always respond in Spanish.`
33-
* `Do not generate code blocks in responses.`
34-
* `For questions related to security, use the Security Docs Knowledge Base.`
35-
36-
> [!NOTE]
37-
> * {% data reusables.copilot.custom-instructions-chat-precedence %}
38-
> * For {% data variables.copilot.copilot_code-review_short %}, the order of precedence is: instructions in any applicable `.github/instructions/**/NAME.instructions.md` file, then the instructions in the `.github/copilot-instructions.md` file, then the organization-level custom instructions.
39-
> * {% data reusables.copilot.custom-instructions-conflict %}
20+
Organization owners can add instructions for {% data variables.product.prodname_copilot_short %}, to tailor responses to specific needs and preferences across the organization. For an overview of this, and other types of custom instructions for {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/concepts/about-customizing-github-copilot-chat-responses?tool=webui).
4021

4122
## Adding organization custom instructions
4223

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

Lines changed: 10 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ redirect_from:
1919

2020
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 -->
2121

22-
{% data reusables.copilot.repository-custom-instructions-support %}
22+
{% data reusables.copilot.repository-custom-instructions-about %}
2323

2424
{% data reusables.copilot.repository-custom-instructions-prerequisites %}
2525

@@ -29,7 +29,7 @@ This version of this article is for using repository custom instructions on the
2929

3030
This version of this article is for using repository custom instructions and prompt files in {% data variables.product.prodname_vscode_shortname %}. Click the tabs above for instructions on using custom instructions in other environments.
3131

32-
{% data reusables.copilot.repository-custom-instructions-support %}
32+
{% data reusables.copilot.repository-custom-instructions-about %}
3333

3434
{% data reusables.copilot.repository-custom-instructions-prerequisites %}
3535

@@ -39,7 +39,7 @@ This version of this article is for using repository custom instructions and pro
3939

4040
This version of this article is for using repository custom instructions in {% data variables.product.prodname_vs %}. Click the tabs above for instructions on using custom instructions in other environments.
4141

42-
{% data reusables.copilot.repository-custom-instructions-support %}
42+
{% data reusables.copilot.repository-custom-instructions-about %}
4343

4444
{% data reusables.copilot.repository-custom-instructions-prerequisites %}
4545

@@ -49,7 +49,7 @@ This version of this article is for using repository custom instructions in {% d
4949

5050
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.
5151

52-
{% data reusables.copilot.repository-custom-instructions-support %}
52+
{% data reusables.copilot.repository-custom-instructions-about %}
5353

5454
{% data reusables.copilot.repository-custom-instructions-prerequisites %}
5555

@@ -59,7 +59,7 @@ This version of this article is for using repository custom instructions in JetB
5959

6060
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.
6161

62-
{% data reusables.copilot.repository-custom-instructions-support %}
62+
{% data reusables.copilot.repository-custom-instructions-about %}
6363

6464
{% data reusables.copilot.repository-custom-instructions-prerequisites %}
6565

@@ -79,7 +79,7 @@ This version of this article is for using repository custom instructions with th
7979
8080
This version of this article is for using repository custom instructions in Eclipse. Click the tabs above for instructions on using custom instructions in other environments.
8181

82-
{% data reusables.copilot.repository-custom-instructions-support %}
82+
{% data reusables.copilot.repository-custom-instructions-about %}
8383

8484
{% data reusables.copilot.repository-custom-instructions-prerequisites %}
8585

@@ -207,7 +207,7 @@ Once saved, these instructions will apply to the current project in Eclipse that
207207

208208
{% copilotcli %}
209209

210-
{% data variables.product.prodname_copilot %} supports three types of repository custom instructions. See the table above for details of which {% data variables.product.prodname_copilot %} features support these types of instructions.
210+
{% data variables.product.prodname_copilot %} supports three types of repository custom instructions.
211211

212212
* **Repository-wide custom instructions**, which apply to all requests made in the context of a repository.
213213

@@ -243,7 +243,7 @@ Once saved, these instructions will apply to the current project in Eclipse that
243243

244244
{% vscode %}
245245

246-
{% data variables.product.prodname_vscode_shortname %} supports three types of repository custom instructions. See the table above for details of which {% data variables.product.prodname_copilot %} features support these types of instructions.
246+
{% data variables.product.prodname_vscode_shortname %} supports three types of repository custom instructions. For details of which {% data variables.product.prodname_copilot %} features support these types of instructions, see [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=vscode#support-for-repository-custom-instructions-1).
247247

248248
* **Repository-wide custom instructions**, which apply to all requests made in the context of a repository.
249249

@@ -297,7 +297,7 @@ Once saved, these instructions will apply to the current project in Eclipse that
297297

298298
{% webui %}
299299

300-
{% data variables.product.prodname_copilot_short %} on {% data variables.product.github %} supports three types of repository custom instructions. See the table above for details of which {% data variables.product.prodname_copilot %} features support these types of instructions.
300+
{% data variables.product.prodname_copilot_short %} on {% data variables.product.github %} supports three types of repository custom instructions. For details of which {% data variables.product.prodname_copilot %} features support these types of instructions, see [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=webui#support-for-repository-custom-instructions).
301301

302302
* **Repository-wide custom instructions** apply to all requests made in the context of a repository.
303303

@@ -311,7 +311,7 @@ Once saved, these instructions will apply to the current project in Eclipse that
311311

312312
* **Agent instructions** are used by AI agents.
313313

314-
You can create one or more `AGENTS.md` files, stored anywhere within the repository. When {% data variables.product.prodname_copilot_short %} is working, the nearest `AGENTS.md` file in the directory tree will take precedence. For more information, see the [openai/agents.md repository](https://github.com/openai/agents.md).
314+
You can create one or more `AGENTS.md` files, stored anywhere within the repository. When {% data variables.product.prodname_copilot_short %} is working, the nearest `AGENTS.md` file in the directory tree will take precedence over other agent instructions files. For more information, see the [openai/agents.md repository](https://github.com/openai/agents.md).
315315

316316
Alternatively, you can use a single `CLAUDE.md` or `GEMINI.md` file stored in the root of the repository.
317317

@@ -438,67 +438,6 @@ Did you successfully add a custom instructions file to your repository?
438438

439439
{% endnote %}
440440

441-
## Writing effective repository custom instructions
442-
443-
The instructions you add to your custom instruction file(s) should be short, self-contained statements that provide {% data variables.product.prodname_copilot_short %} with relevant information to help it work in this repository. Because the instructions are sent with every chat message, they should be broadly applicable to most requests you will make in the context of the repository.
444-
445-
The exact structure you utilize for your instructions file(s) will vary by project and need, but the following guidelines provide a good starting point:
446-
447-
* Provide an overview of the project you're working on, including its purpose, goals, and any relevant background information.
448-
* Include the folder structure of the repository, including any important directories or files that are relevant to the project.
449-
* Specify the coding standards and conventions that should be followed, such as naming conventions, formatting rules, and best practices.
450-
* Include any specific tools, libraries, or frameworks that are used in the project, along with any relevant version numbers or configurations.
451-
452-
The following instructions file(s) is an example of these practices in action:
453-
454-
```markdown
455-
# Project Overview
456-
457-
This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.
458-
459-
## Folder Structure
460-
461-
- `/src`: Contains the source code for the frontend.
462-
- `/server`: Contains the source code for the Node.js backend.
463-
- `/docs`: Contains documentation for the project, including API specifications and user guides.
464-
465-
## Libraries and Frameworks
466-
467-
- React and Tailwind CSS for the frontend.
468-
- Node.js and Express for the backend.
469-
- MongoDB for data storage.
470-
471-
## Coding Standards
472-
473-
- Use semicolons at the end of each statement.
474-
- Use single quotes for strings.
475-
- Use function based components in React.
476-
- Use arrow functions for callbacks.
477-
478-
## UI guidelines
479-
480-
- A toggle is provided to switch between light and dark mode.
481-
- Application should have a modern and clean design.
482-
```
483-
484-
You should also consider the size and complexity of your repository. The following types of instructions may work for a small repository with only a few contributors, but for a large and diverse repository, **these may cause problems**:
485-
486-
* Requests to refer to external resources when formulating a response
487-
* Instructions to answer in a particular style
488-
* Requests to always respond with a certain level of detail
489-
490-
For example, the following instructions **may not have the intended results**:
491-
492-
```markdown
493-
Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code.
494-
495-
Use @terminal when answering questions about Git.
496-
497-
Answer all questions in the style of a friendly colleague, using informal language.
498-
499-
Answer all questions in less than 1000 characters, and words of no more than 12 characters.
500-
```
501-
502441
## Repository custom instructions in use
503442

504443
The instructions in the file(s) are available for use by {% data variables.product.prodname_copilot_short %} as soon as you save the file(s). The complete set of instructions will be automatically added to requests that you submit to {% data variables.product.prodname_copilot_short %} in the context of that repository. For example, they are added to the prompt you submit to {% data variables.copilot.copilot_chat_short %}.

data/reusables/copilot/custom-instructions-about.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@
22

33
These are specified in a `copilot-instructions.md` file in the `.github` directory of the repository.
44

5-
Repository-wide custom instructions files are used for chat responses, for code review, and also by {% data variables.copilot.copilot_coding_agent %}.
6-
75
* **Path-specific custom instructions**, which apply to requests made in the context of files that match a specified path.
86

97
These are specified in one or more `NAME.instructions.md` files within the `.github/instructions` directory in the repository.
108

119
By using path-specific instructions you can avoid overloading your repository-wide instructions with information that only applies to files of certain types, or in certain directories.
1210

13-
> [!NOTE]
14-
> Currently, path-specific custom instructions files are only used by {% data variables.copilot.copilot_code-review_short %}, {% data variables.copilot.copilot_coding_agent %}, and {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_vscode_shortname %}.
11+
* **Agent instructions**, which are similar to repository-wide custom instructions, but are currently not supported by all {% data variables.product.prodname_copilot_short %} features.
12+
13+
These are specified in files called `AGENTS.md`, `CLAUDE.md`, or `GEMINI.md`.
14+
15+
See the table below for details of support for each of these types of repository custom instructions across different {% data variables.product.prodname_copilot_short %} features.
1516

1617
For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions).
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
## Writing effective custom instructions
2+
3+
The instructions you add to your custom instruction file(s) should be short, self-contained statements that provide {% data variables.product.prodname_copilot_short %} with relevant information to help it work in this repository. Because the instructions are sent with every chat message, they should be broadly applicable to most requests you will make in the context of the repository.
4+
5+
The exact structure you utilize for your instructions file(s) will vary by project and need, but the following guidelines provide a good starting point:
6+
7+
* Provide an overview of the project you're working on, including its purpose, goals, and any relevant background information.
8+
* Include the folder structure of the repository, including any important directories or files that are relevant to the project.
9+
* Specify the coding standards and conventions that should be followed, such as naming conventions, formatting rules, and best practices.
10+
* Include any specific tools, libraries, or frameworks that are used in the project, along with any relevant version numbers or configurations.
11+
12+
The following instructions file is an example of these practices in action:
13+
14+
```markdown
15+
# Project Overview
16+
17+
This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.
18+
19+
## Folder Structure
20+
21+
- `/src`: Contains the source code for the frontend.
22+
- `/server`: Contains the source code for the Node.js backend.
23+
- `/docs`: Contains documentation for the project, including API specifications and user guides.
24+
25+
## Libraries and Frameworks
26+
27+
- React and Tailwind CSS for the frontend.
28+
- Node.js and Express for the backend.
29+
- MongoDB for data storage.
30+
31+
## Coding Standards
32+
33+
- Use semicolons at the end of each statement.
34+
- Use single quotes for strings.
35+
- Use function based components in React.
36+
- Use arrow functions for callbacks.
37+
38+
## UI guidelines
39+
40+
- A toggle is provided to switch between light and dark mode.
41+
- Application should have a modern and clean design.
42+
```
43+
44+
You should also consider the size and complexity of your repository. The following types of instructions may work for a small repository with only a few contributors, but for a large and diverse repository, **these may cause problems**:
45+
46+
* Requests to refer to external resources when formulating a response
47+
* Instructions to answer in a particular style
48+
* Requests to always respond with a certain level of detail
49+
50+
For example, the following instructions **may not have the intended results**:
51+
52+
```markdown
53+
Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code.
54+
55+
Use @terminal when answering questions about Git.
56+
57+
Answer all questions in the style of a friendly colleague, using informal language.
58+
59+
Answer all questions in less than 1000 characters, and words of no more than 12 characters.
60+
```

0 commit comments

Comments
 (0)