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
56 changes: 56 additions & 0 deletions content/copilot/get-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -369,3 +369,59 @@ The following example uses Swift, however other languages will work similarly.
{% data reusables.copilot.quickstart-nextsteps2 %}

{% endxcode %}

<!-- --------------------- -->
<!-- Eclipse -->
<!-- --------------------- -->

{% eclipse %}

{% data reusables.copilot.quickstart-intro %}

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.

{% ifversion fpt %}
{% data reusables.copilot.quickstart-signup %}
{% endif %}

## Prerequisites

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

## Chat with {% data variables.product.prodname_copilot %}

After you've installed the {% data variables.product.prodname_copilot %} plugin, you can ask {% data variables.product.prodname_copilot_short %} coding-related questions.

> [!NOTE] {% data reusables.copilot.chat-access-denied %}

1. Open an existing code file.
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**.
1. In the {% data variables.copilot.copilot_chat_short %} window, type `what does this file do` then press <kbd>Enter</kbd>.

{% data variables.product.prodname_copilot_short %}'s answer is displayed below your question.

1. Select a line of code in the editor.
1. In the {% data variables.copilot.copilot_chat_short %} window, type `explain this line` then press <kbd>Enter</kbd>.

## Get your first code completion suggestion

The following example uses Java, however other languages will work similarly.

1. Create a new Java class called `CalculateDaysBetween`.
1. Within the class add the following comment:

```java copy
// Take 2 dates and return the number of days between them
```

{% data variables.product.prodname_copilot %} adds a suggestion of code to use for this class. Suggestions are displayed in grayed text.
1. {% data reusables.copilot.accept-suggestion %}

## Next steps

{% data reusables.copilot.quickstart-nextsteps1 %}
{% data reusables.copilot.quickstart-nextsteps2 %}

{% endeclipse %}
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,9 @@ Once saved, these instructions will apply to the current project in Eclipse that

## Creating repository-wide custom instructions

> [!NOTE]
> {% data reusables.copilot.custom-instructions-ccr-support %} See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review?tool=vscode).

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,9 @@ To provide feedback, hover over the comment and click the thumbs up or thumbs do

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

> [!NOTE]
> {% data reusables.copilot.custom-instructions-ccr-support %}

{% data reusables.copilot.code-review.custom-instructions-information %}

{% endvscode %}
Expand Down
1 change: 1 addition & 0 deletions data/reusables/copilot/custom-instructions-ccr-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +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.
15 changes: 9 additions & 6 deletions data/reusables/copilot/repository-custom-instructions-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,23 @@ Repository custom instructions let you provide {% data variables.product.prodnam

### Support for repository custom instructions

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

{% rowheaders %}

| | Eclipse | JetBrains IDEs | {% data variables.product.prodname_vs %} | {% data variables.product.prodname_vscode_shortname %} | {% data variables.product.prodname_dotcom_the_website %} | Xcode |
| --- | --- | --- | --- | --- | --- | --- |
| {% 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> |
| {% 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 |
| {% 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" %} |
| {% 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 |
| {% 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" %} |

{% endrowheaders %}

**1:** Repository-wide instructions (using the `.github/copilot-instructions.md` file) are supported.<br>
**2:** Repository-wide instructions and path-specific instructions (using `.github/instructions/**/NAME.instructions.md` files) are supported.<br>
**3:** Repository-wide instructions, path-specific instructions, and agent instructions (using `AGENTS.md`, `CLAUDE.md` or `GEMINI.md` files) are supported.<br>
**Types of custom instructions supported**

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