Skip to content

Commit 6edf91b

Browse files
committed
Small formatting updates
1 parent 6033a81 commit 6edf91b

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/5-reviewing-coding-agent.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Review GitHub Copilot coding agent's work
1+
# Exercise 5: Review GitHub Copilot coding agent's work
22

33
| [← Adding new functionality with Copilot Agent Mode][previous-lesson] |
44
|:----:|
@@ -30,7 +30,7 @@ Let's start by exploring the first pull request (PR) generated by GitHub Copilot
3030
3. Open issue titled something similar to **Add missing documentation** or something more robust.
3131

3232
> [!NOTE]
33-
> If Copilot is still working on the task, the issue will contain the **WIP** flag. If so, wait for Copilot to complete the work. This may take a few minutes, so feel free to take a break, or reflect on everything you've learned so far.
33+
> If Copilot is still working on the task, the issue will contain the **[WIP]** flag. If so, wait for Copilot to complete the work. This may take a few minutes, so feel free to take a break, or reflect on everything you've learned so far.
3434
3535
4. Once the pull request is ready, select the **Files changed** tab and review the changes.
3636

@@ -43,7 +43,7 @@ Let's start by exploring the first pull request (PR) generated by GitHub Copilot
4343

4444
![Approve and run workflows](images/ex4-approve-and-run.png)
4545

46-
9. You should see the workflows get queued in the checks section of the pull request. All being well, you should see that the workflows pass for both the backend and frontend. This may take a few minutes to complete.
46+
9. You should see the workflows get queued in the checks section of the pull request. All being well, you should see that the workflows pass for both the backend and frontend. This may take a few minutes to complete.
4747

4848
## Requesting changes from GitHub Copilot
4949

@@ -54,14 +54,14 @@ Working with Copilot on a pull request is not just a one-way street. You can als
5454
- Create a README in both the server and client folders with descriptions of the codebase of each.
5555

5656
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.
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.
6060

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

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.
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.
6565

6666
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.
6767

@@ -81,7 +81,7 @@ Let's return to the PR Copilot generated for resolving our issue about adding en
8181

8282
![Approve and run workflows](images/ex4-approve-and-run.png)
8383

84-
8. You should see the workflows get queued in the checks section of the pull request. All being well, you should see that the workflows pass for both the backend and frontend. This may take a few minutes to complete.
84+
8. You should see the workflows get queued in the checks section of the pull request. All being well, you should see that the workflows pass for both the backend and frontend. This may take a few minutes to complete.
8585

8686
Copilot has created the new endpoints! Just as before, you can work iteratively with Copilot coding agent to request updates. For example, you might want to request Copilot centralizes the error handling to reduce duplication, or ensuring comments and docstrings are added (remember - this was assigned **before** we made the updates to our custom instructions!) Just like before, you can make these requests by adding a new comment on the **Conversation** tab, which Copilot will see and kickoff a new session.
8787

@@ -127,4 +127,4 @@ This is just the beginning, and we can't wait to see how you use Copilot to help
127127
[coding-agent-best-practices]: https://docs.github.com/en/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks
128128
[agent-firewall]: https://docs.github.com/en/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent
129129

130-
[previous-lesson]: ./4-copilot-agent-mode-vscode.md
130+
[previous-lesson]: ./4-copilot-agent-mode-vscode.md

0 commit comments

Comments
 (0)