Skip to content

Commit 350fa39

Browse files
authored
Merge pull request #40767 from github/repo-sync
Repo sync
2 parents 8bd120a + bac4fdd commit 350fa39

File tree

5 files changed

+72
-6
lines changed

5 files changed

+72
-6
lines changed

content/copilot/get-started/quickstart.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -369,3 +369,59 @@ The following example uses Swift, however other languages will work similarly.
369369
{% data reusables.copilot.quickstart-nextsteps2 %}
370370

371371
{% endxcode %}
372+
373+
<!-- --------------------- -->
374+
<!-- Eclipse -->
375+
<!-- --------------------- -->
376+
377+
{% eclipse %}
378+
379+
{% data reusables.copilot.quickstart-intro %}
380+
381+
Instructions for using {% data variables.product.prodname_copilot_short %} differ depending on where you are using it. This version of the quickstart is for Eclipse. Click the tabs above for instructions on using {% data variables.product.prodname_copilot_short %} in other environments.
382+
383+
{% ifversion fpt %}
384+
{% data reusables.copilot.quickstart-signup %}
385+
{% endif %}
386+
387+
## Prerequisites
388+
389+
* **Subscription to {% data variables.product.prodname_copilot_short %}**. To use {% data variables.product.prodname_copilot %} in Eclipse, you must have an active {% data variables.product.prodname_copilot %} subscription. {% data reusables.copilot.subscription-prerequisite %}
390+
* **Latest version of the {% data variables.product.prodname_copilot %} extension**. For installation instructions, see [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension?tool=eclipse).
391+
* **Sign in to {% data variables.product.company_short %} in Eclipse**. If you experience authentication issues, see [AUTOTITLE](/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat#troubleshooting-authentication-issues-in-your-editor).
392+
393+
## Chat with {% data variables.product.prodname_copilot %}
394+
395+
After you've installed the {% data variables.product.prodname_copilot %} plugin, you can ask {% data variables.product.prodname_copilot_short %} coding-related questions.
396+
397+
> [!NOTE] {% data reusables.copilot.chat-access-denied %}
398+
399+
1. Open an existing code file.
400+
1. In the menu bar of Eclipse, click **{% data variables.product.prodname_copilot_short %}**, then click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} Open Chat**.
401+
1. In the {% data variables.copilot.copilot_chat_short %} window, type `what does this file do` then press <kbd>Enter</kbd>.
402+
403+
{% data variables.product.prodname_copilot_short %}'s answer is displayed below your question.
404+
405+
1. Select a line of code in the editor.
406+
1. In the {% data variables.copilot.copilot_chat_short %} window, type `explain this line` then press <kbd>Enter</kbd>.
407+
408+
## Get your first code completion suggestion
409+
410+
The following example uses Java, however other languages will work similarly.
411+
412+
1. Create a new Java class called `CalculateDaysBetween`.
413+
1. Within the class add the following comment:
414+
415+
```java copy
416+
// Take 2 dates and return the number of days between them
417+
```
418+
419+
{% data variables.product.prodname_copilot %} adds a suggestion of code to use for this class. Suggestions are displayed in grayed text.
420+
1. {% data reusables.copilot.accept-suggestion %}
421+
422+
## Next steps
423+
424+
{% data reusables.copilot.quickstart-nextsteps1 %}
425+
{% data reusables.copilot.quickstart-nextsteps2 %}
426+
427+
{% endeclipse %}

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,9 @@ Once saved, these instructions will apply to the current project in Eclipse that
261261

262262
## Creating repository-wide custom instructions
263263

264+
> [!NOTE]
265+
> {% data reusables.copilot.custom-instructions-ccr-support %} See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review?tool=vscode).
266+
264267
1. In the root of your repository, create a file named `.github/copilot-instructions.md`.
265268

266269
Create the `.github` directory if it does not already exist.

content/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,9 @@ To provide feedback, hover over the comment and click the thumbs up or thumbs do
134134

135135
## Customizing {% data variables.product.prodname_copilot_short %}'s reviews with custom instructions
136136

137+
> [!NOTE]
138+
> {% data reusables.copilot.custom-instructions-ccr-support %}
139+
137140
{% data reusables.copilot.code-review.custom-instructions-information %}
138141

139142
{% endvscode %}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Currently, {% data variables.copilot.copilot_code-review_short %} in {% data variables.product.prodname_vscode_shortname %} only supports repository-wide custom instructions, and these are only supported when you are reviewing a selection of code in a file, not when reviewing all uncommitted changes.

data/reusables/copilot/repository-custom-instructions-support.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,23 @@ Repository custom instructions let you provide {% data variables.product.prodnam
44

55
### Support for repository custom instructions
66

7-
The following table shows which {% data variables.product.prodname_copilot_short %} features support the `.github/copilot-instructions.md` instructions file.
7+
The following table shows which {% data variables.product.prodname_copilot_short %} features support custom instructions in various environments.
88

99
{% rowheaders %}
1010

1111
| | Eclipse | JetBrains IDEs | {% data variables.product.prodname_vs %} | {% data variables.product.prodname_vscode_shortname %} | {% data variables.product.prodname_dotcom_the_website %} | Xcode |
1212
| --- | --- | --- | --- | --- | --- | --- |
1313
| {% data variables.copilot.copilot_chat_short %} | {% octicon "check" aria-label="Included" %} <sup>1</sup> | {% octicon "check" aria-label="Included" %} <sup>1</sup> | {% octicon "check" aria-label="Included" %} <sup>1</sup> | {% octicon "check" aria-label="Included" %} <sup>3</sup> | {% octicon "check" aria-label="Included" %} <sup>1</sup> | {% octicon "check" aria-label="Included" %} <sup>1</sup> |
14-
| {% data variables.copilot.copilot_coding_agent %} | N/A | N/A | N/A | {% octicon "check" aria-label="Included" %} <sup>3</sup> | {% octicon "check" aria-label="Included" %} <sup>3</sup> | N/A |
15-
| {% data variables.copilot.copilot_code-review_short %} | N/A | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} <sup>1</sup> | {% octicon "check" aria-label="Included" %} <sup>2</sup> | {% octicon "check" aria-label="Included" %} <sup>2</sup> | {% octicon "x" aria-label="Not included" %} |
14+
| {% data variables.copilot.copilot_coding_agent %} | N/A | N/A | N/A | {% octicon "check" aria-label="Included" %} <sup>4</sup> | {% octicon "check" aria-label="Included" %} <sup>4</sup> | N/A |
15+
| {% data variables.copilot.copilot_code-review_short %} | N/A | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} <sup>1</sup> | {% octicon "check" aria-label="Included" %} <sup>1</sup> | {% octicon "check" aria-label="Included" %} <sup>2</sup> | {% octicon "x" aria-label="Not included" %} |
1616

1717
{% endrowheaders %}
1818

19-
**1:** Repository-wide instructions (using the `.github/copilot-instructions.md` file) are supported.<br>
20-
**2:** Repository-wide instructions and path-specific instructions (using `.github/instructions/**/NAME.instructions.md` files) are supported.<br>
21-
**3:** Repository-wide instructions, path-specific instructions, and agent instructions (using `AGENTS.md`, `CLAUDE.md` or `GEMINI.md` files) are supported.<br>
19+
**Types of custom instructions supported**
20+
21+
**1:** Repository-wide instructions (using the `.github/copilot-instructions.md` file).<br>
22+
**2:** Repository-wide instructions and path-specific instructions (using `.github/instructions/**/NAME.instructions.md` files).<br>
23+
**3:** Repository-wide instructions, path-specific instructions, and a single `AGENTS.md` file in the root of the workspace.<br>
24+
**4:** Repository-wide instructions, path-specific instructions, and agent instructions (using `AGENTS.md`, `CLAUDE.md` or `GEMINI.md` files).<br>
2225
**X:** Custom instructions are not supported.<br>
2326
**N/A:** Feature not available on this platform.

0 commit comments

Comments
 (0)