Skip to content

Commit 8b951ca

Browse files
authored
Copilot: mention write access requirement for CCA responding to comments (#55766)
1 parent 084fffc commit 8b951ca

File tree

5 files changed

+11
-5
lines changed

5 files changed

+11
-5
lines changed
Loading

content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/best-practices-for-using-copilot-to-work-on-tasks.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,10 @@ Issues that you may choose to work on yourself, rather than assigning to {% data
5454

5555
Working with {% data variables.product.prodname_copilot_short %} on a pull request is just like working with a human developer: it's common for the pull request to need further work before it can be merged. The process for getting the pull request to a mergeable state is exactly the same when the pull request is created by {% data variables.product.prodname_copilot_short %} as when it's created by a human. If you want, you can work on the feature branch yourself and push changes to the pull request. However, you can also just add comments to the pull request—explaining what you think is incorrect, or could be improved—and leave {% data variables.product.prodname_copilot_short %} to make the required changes.
5656

57-
{% data variables.product.prodname_copilot_short %} will read all comments as soon as they are submitted, and will decide whether they require action. It will then start to make any required changes, and will update the pull request when it's done. Because {% data variables.product.prodname_copilot_short %} starts looking at comments as soon as they are submitted, if you are likely to make multiple comments on a pull request it's best to batch them by clicking **Start a review**, rather than clicking **Add single comment**. You can then submit all of your comments at once, triggering {% data variables.product.prodname_copilot_short %} to work on your entire review, rather than working on individual comments separately.
57+
{% data variables.product.prodname_copilot_short %} will read all comments as soon as they are submitted by users with write access, and will decide whether they require action. It will then start to make any required changes, and will update the pull request when it's done. Because {% data variables.product.prodname_copilot_short %} starts looking at comments as soon as they are submitted, if you are likely to make multiple comments on a pull request it's best to batch them by clicking **Start a review**, rather than clicking **Add single comment**. You can then submit all of your comments at once, triggering {% data variables.product.prodname_copilot_short %} to work on your entire review, rather than working on individual comments separately.
58+
59+
> [!NOTE]
60+
> {% data reusables.copilot.coding-agent.write-access-required %}
5861
5962
## Adding custom instructions to your repository
6063

content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/reviewing-a-pull-request-created-by-copilot.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ You can ask {% data variables.product.prodname_copilot_short %} to make changes
2626
2727
When you leave a comment on {% data variables.product.prodname_copilot_short %}'s pull request, {% data variables.product.prodname_copilot_short %} will consider your comment, and decide whether to start a new agent session to respond.
2828

29-
If {% data variables.product.prodname_copilot_short %} starts a new agent session in response to your comment, {% data variables.product.prodname_copilot_short %} will react with 👀, and a "Copilot has started work" event will appear in the pull request timeline.
29+
{% data reusables.copilot.coding-agent.write-access-required %}
30+
31+
If {% data variables.product.prodname_copilot_short %} starts a new agent session in response to your comment, an eyes emoji (👀) is added as a reaction to the comment, and a "Copilot has started work" event is added to the pull request timeline.
3032

3133
![Screenshot of a pull request timeline with a review comment with the eyes reaction and a "Copilot started work" timeline event.](/assets/images/help/copilot/coding-agent/comment-to-agent-on-pr.png)
3234

content/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/troubleshooting-copilot-coding-agent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ If there is a "{% data variables.product.prodname_copilot_short %} started work"
5454

5555
## {% data variables.product.prodname_copilot_short %} won't respond to my pull request comments
5656

57-
When you leave a pull request comment on a pull request that is assigned to {% data variables.product.prodname_copilot_short %}, {% data variables.product.prodname_copilot_short %} will consider your comment, and decide whether to start a new agent session to respond.
57+
{% data reusables.copilot.coding-agent.write-access-required %}
5858

59-
If {% data variables.product.prodname_copilot_short %} decides to take action and start a new agent session in response to your comment, it will leave an 👀 reaction on the comment, and then a "{% data variables.product.prodname_copilot_short %} started work" event will appear in the pull request timeline.
59+
If you do have write access, and you add a comment on a pull request that is assigned to {% data variables.product.prodname_copilot_short %}, the comment is passed to {% data variables.copilot.copilot_coding_agent %}. An eyes emoji (👀) is added to your comment to indicate that {% data variables.copilot.copilot_coding_agent %} is considering your comment. If the agent proceeds to work on making changes in response to your comment a "{% data variables.product.prodname_copilot_short %} started work" event is added to the pull request timeline.
6060

61-
If this doesn't happen, you may have unassigned {% data variables.product.prodname_copilot_short %} from the pull request, or {% data variables.product.prodname_copilot_short %} may have decided that your comment is not actionable.
61+
If this doesn't happen, {% data variables.product.prodname_copilot_short %} may have been unassigned from the pull request, or {% data variables.product.prodname_copilot_short %} may have decided that your comment is not actionable.
6262

6363
Check that {% data variables.product.prodname_copilot_short %} is assigned to the pull request. If it is, you can force {% data variables.product.prodname_copilot_short %} to respond to your comment by @mentioning {% data variables.product.prodname_copilot_short %} in the comment with `@copilot`.
6464

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{% data variables.product.prodname_copilot_short %} only responds to comments from people who have write access to the repository.

0 commit comments

Comments
 (0)