Skip to content

Commit 0e00f9f

Browse files
authored
Merge pull request #40065 from github/repo-sync
Repo sync
2 parents 8042ca3 + 03da100 commit 0e00f9f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+811
-1242
lines changed

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Adding repository custom instructions for GitHub Copilot
33
shortTitle: Add repository instructions
4-
intro: 'Create a file in a repository that gives {% data variables.product.prodname_copilot_short %} additional context for the work it does in that repository.'
4+
intro: 'Create repository custom instructions files that give {% data variables.product.prodname_copilot_short %} additional context on how to understand your project and how to build, test and validate its changes.'
55
redirect_from:
66
- /copilot/customizing-copilot/adding-custom-instructions-for-github-copilot
77
- /copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot
@@ -239,7 +239,11 @@ Once saved, these instructions will apply to the current project in Eclipse that
239239

240240
**{% 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.
241241

242-
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.
242+
In addition, **{% data variables.copilot.copilot_coding_agent %}** supports:
243+
244+
* 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.
245+
* 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.
246+
* A single `CLAUDE.md` or `GEMINI.md` file stored in the root of the repository.
243247

244248
### Using a single `.github/copilot-instructions.md` file
245249

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,13 @@ By adding custom instructions to your repository, you can guide {% data variable
7777

7878
If {% data variables.product.prodname_copilot_short %} is able to build, test and validate its changes in its own development environment, it is more likely to produce good pull requests which can be merged quickly.
7979

80-
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.
80+
{% data variables.copilot.copilot_coding_agent %} supports a number of different types of custom instructions files:
81+
82+
* `/.github/copilot-instructions.md`
83+
* `/.github/instructions/**/*.instructions.md`
84+
* `**/AGENTS.md`
85+
* `/CLAUDE.md`
86+
* `/GEMINI.md`
8187

8288
For more information, see [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot?tool=webui).
8389

next.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ const { data } = frontmatter(fs.readFileSync(homepage, 'utf8'))
1515
const productIds = data.children
1616

1717
export default {
18+
// Transpile @primer/react so Next's webpack can process its CSS and other assets
19+
// This ensures CSS in node_modules/@primer/react is handled by the app's loaders.
20+
transpilePackages: ['@primer/react'],
1821
// speed up production `next build` by ignoring typechecking during that step of build.
1922
// type-checking still occurs in the Dockerfile build
2023
typescript: {

0 commit comments

Comments
 (0)