Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# Docs changelog

**24 October 2025**

To support the enterprise roles and teams public preview, we:

* 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.
* 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).
* 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).
* 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).

<hr>

**17 October 2025**

We have updated the [Account and profile](https://docs.github.com/en/account-and-profile) and [Subscriptions and notifications](https://docs.github.com/en/subscriptions-and-notifications) docs for improved usability, scannability, and information architecture.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ redirect_from:
- /admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise
- /admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/roles-in-an-enterprise
- /admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/abilities-of-roles
- /early-access/enterprise/enterprise-roles/enterprise-security-manager
versions:
ghec: '*'
ghes: '*'
Expand Down Expand Up @@ -93,7 +94,7 @@ App managers can also be assigned to individual apps. See [AUTOTITLE](/admin/man
## Security managers

> [!NOTE]
> 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.
> The enterprise security manager role is in {% data variables.release-phases.public_preview %} and subject to change.

Security managers have the permissions required to effectively manage use of security features and alerts for the enterprise. They can view, manage, and assign:

Expand Down
295 changes: 154 additions & 141 deletions content/copilot/concepts/prompting/response-customization.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -15,28 +15,9 @@ redirect_from:
contentType: how-tos
---

> [!NOTE]
> This feature is currently in {% data variables.release-phases.public_preview %} and is subject to change.
>
> **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 %}.
{% data reusables.copilot.custom-instructions-org-support %}

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).

## About organization custom instructions for {% data variables.product.prodname_copilot_short %}

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.

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.

Some examples of instructions you could add are:
* `Always respond in Spanish.`
* `Do not generate code blocks in responses.`
* `For questions related to security, use the Security Docs Knowledge Base.`

> [!NOTE]
> * {% data reusables.copilot.custom-instructions-chat-precedence %}
> * 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.
> * {% data reusables.copilot.custom-instructions-conflict %}
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).

## Adding organization custom instructions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ redirect_from:

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

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

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

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

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.

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

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

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

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.

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

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

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

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.

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

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

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

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.

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

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

Expand All @@ -79,7 +79,7 @@ This version of this article is for using repository custom instructions with th

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.

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

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

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

{% copilotcli %}

{% 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.
{% data variables.product.prodname_copilot %} supports three types of repository custom instructions.

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

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

{% vscode %}

{% 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.
{% 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).

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

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

{% webui %}

{% 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.
{% 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).

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

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

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

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).
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).

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

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

{% endnote %}

## Writing effective repository custom instructions

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.

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:

* Provide an overview of the project you're working on, including its purpose, goals, and any relevant background information.
* Include the folder structure of the repository, including any important directories or files that are relevant to the project.
* Specify the coding standards and conventions that should be followed, such as naming conventions, formatting rules, and best practices.
* Include any specific tools, libraries, or frameworks that are used in the project, along with any relevant version numbers or configurations.

The following instructions file(s) is an example of these practices in action:

```markdown
# Project Overview

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.

## Folder Structure

- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.

## Libraries and Frameworks

- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.

## Coding Standards

- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.

## UI guidelines

- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.
```

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**:

* Requests to refer to external resources when formulating a response
* Instructions to answer in a particular style
* Requests to always respond with a certain level of detail

For example, the following instructions **may not have the intended results**:

```markdown
Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code.

Use @terminal when answering questions about Git.

Answer all questions in the style of a friendly colleague, using informal language.

Answer all questions in less than 1000 characters, and words of no more than 12 characters.
```

## Repository custom instructions in use

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 %}.
Expand Down
9 changes: 5 additions & 4 deletions data/reusables/copilot/custom-instructions-about.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,16 @@

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

Repository-wide custom instructions files are used for chat responses, for code review, and also by {% data variables.copilot.copilot_coding_agent %}.

* **Path-specific custom instructions**, which apply to requests made in the context of files that match a specified path.

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

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.

> [!NOTE]
> Currently, path-specific custom instructions files are only used by {% data variables.copilot.copilot_code-review_short %}, {% data variables.copilot.copilot_coding_agent %}, and {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_vscode_shortname %}.
* **Agent instructions**, which are similar to repository-wide custom instructions, but are currently not supported by all {% data variables.product.prodname_copilot_short %} features.

These are specified in files called `AGENTS.md`, `CLAUDE.md`, or `GEMINI.md`.

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.

For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions).
60 changes: 60 additions & 0 deletions data/reusables/copilot/custom-instructions-effective.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
## Writing effective custom instructions

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.

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:

* Provide an overview of the project you're working on, including its purpose, goals, and any relevant background information.
* Include the folder structure of the repository, including any important directories or files that are relevant to the project.
* Specify the coding standards and conventions that should be followed, such as naming conventions, formatting rules, and best practices.
* Include any specific tools, libraries, or frameworks that are used in the project, along with any relevant version numbers or configurations.

The following instructions file is an example of these practices in action:

```markdown
# Project Overview

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.

## Folder Structure

- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.

## Libraries and Frameworks

- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.

## Coding Standards

- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.

## UI guidelines

- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.
```

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**:

* Requests to refer to external resources when formulating a response
* Instructions to answer in a particular style
* Requests to always respond with a certain level of detail

For example, the following instructions **may not have the intended results**:

```markdown
Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code.

Use @terminal when answering questions about Git.

Answer all questions in the style of a friendly colleague, using informal language.

Answer all questions in less than 1000 characters, and words of no more than 12 characters.
```
Loading
Loading