Skip to content

Commit 67e867b

Browse files
committed
Enhance instructions for requesting changes from GitHub Copilot by including tagging guidance and improving clarity in the steps.
1 parent ce953b1 commit 67e867b

1 file changed

Lines changed: 6 additions & 7 deletions

File tree

docs/5-reviewing-coding-agent.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,21 +47,20 @@ Let's start by exploring the first pull request (PR) generated by GitHub Copilot
4747

4848
## Requesting changes from GitHub Copilot
4949

50-
Working with Copilot on a pull request is not just a one-way street. You can also add comments to the pull request, or inline comments to the code. Copilot will see these comments, and trigger another session to address them. Due to the non-deterministic results, we can't give prescriptive text of what to ask for. Some ideas of what to ask Copilot to update include:
50+
Working with Copilot on a pull request is not just a one-way street. You can also tag Copilot in comments - like you would other members of your team - in the pull request, or inline comments of the code. Copilot will see these comments, and trigger another session to address them. Due to the non-deterministic results, we can't give prescriptive text of what to ask for. Some ideas of what to ask Copilot to update include:
5151

5252
- Add comment headers to the top of each code file with a brief description of what they do.
5353
- Add docstrings to TypeScript and Svelte files.
5454
- Create a README in both the server and client folders with descriptions of the codebase of each.
5555

56-
1. Add a comment requesting a change to the generated documentation. Use one of the ideas above, or another suggestion for Copilot around documentation you'd like to see in the codebase.
57-
2. Feel free to watch the session as Copilot works on the changes.
58-
3. Select **View Session** to watch Copilot perform its work. Notice how Copilot starts a new session to make the updates.
59-
4. You can select **Back to pull request** to return to the pull request.
56+
1. Add a comment requesting a change to the generated documentation, tagging **@copilot** like you would any user. Use one of the ideas above, or another suggestion for Copilot around documentation you'd like to see in the codebase.
57+
2. Select **View Session** to watch Copilot perform its work. Notice how Copilot starts a new session to make the updates.
58+
3. You can select **Back to pull request** to return to the pull request.
6059

6160
![Back to pull request](images/ex4-back-to-pr.png)
6261

63-
5. Once Copilot has completed the changes, you should see a new commit in the pull request.
64-
6. Select the **Files changed** tab to review the changes.
62+
4. Once Copilot has completed the changes, you should see a new commit in the pull request.
63+
5. Select the **Files changed** tab to review the changes.
6564

6665
Feel free to continue iterating until you are happy. Once happy, you can convert the PR to ready from a draft, and merge it into the main branch.
6766

0 commit comments

Comments
 (0)