Skip to content

Commit ce953b1

Browse files
committed
Improve clarity in instructions for running the website and interacting with Copilot, including formatting adjustments and prompt simplifications.
1 parent b1bec35 commit ce953b1

1 file changed

Lines changed: 8 additions & 14 deletions

File tree

docs/4-copilot-agent-mode-vscode.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The website is a crowdfunding platform for board games with a developer theme. I
3030
To make running the website easier, we have provided a script that will start both the front-end and back-end servers. You can run this script in your GitHub Codespace to start the website with the following instructions:
3131

3232
1. Return to your codespace. We'll continue working in your current branch.
33-
2. Open a new terminal window inside your codespace by selecting <kbd>Ctl</kbd>+<kbd>\`</kbd>.
33+
2. Open a new terminal window inside your codespace by selecting <kbd>Ctl</kbd> + <kbd>\`</kbd>.
3434
3. Run the following script to start the website:
3535

3636
```bash
@@ -67,21 +67,18 @@ The initial implementation of the website is functional, but we want to enhance
6767
2. Open **Copilot Chat**.
6868
3. Create a new chat session by selecting the **New Chat** button, which will remove any previous context.
6969
4. Ensure **Agent** is selected from the list of modes.
70-
71-
![Screenshot of the Copilot Chat panel showing the Agent Mode dropdown](images/copilot-agent-mode-dropdown.png)
72-
7370
5. Select **Claude Sonnet 4** from the list of available models.
7471

7572
> [!IMPORTANT]
7673
> The authors of this lab are not indicating a preference towards one model or another. When building this lab, we used Claude Sonnet 4, and as such are including that in the instructions. The hope is the code suggestions you receive will be relatively consistent to ensure a good experience. However, because LLMs are probabilistic, you may notice the suggestions received differ from what is indicated in the lab. This is perfectly normal and expected.
7774
78-
5. Ask Copilot about the backlog of issues by sending the following prompt to Copilot, replacing **<YOUR_REPOSITORY_PATH>** with the organization/name of your repository which you noted earlier:
75+
1. Ask Copilot about the backlog of issues by sending the following prompt to Copilot:
7976

8077
```plaintext
81-
Please show me the backlog of items from my repository at <YOUR_REPOSITORY_PATH>. Help me prioritize them based on those which will be most useful to the user.
78+
Please show me the backlog of items from my GitHub repository. Help me prioritize them based on those which will be most useful to the user.
8279
```
8380

84-
6. Notice GitHub Copilot (likely) identifies `list_issues` or `search_issues` as the MCP command to run to access the right information.
81+
2. Notice GitHub Copilot (likely) identifies `list_issues` or `search_issues` as the MCP command to run to access the right information.
8582

8683
> [!NOTE]
8784
> Because of the probabilistic nature of LLMs, Copilot may utilize a different MCP command, but should still be able to complete the task.
@@ -110,14 +107,11 @@ In addition, the tests need to run (and pass) before we merge everything into ou
110107
> Even though Copilot agent mode may have discovered this file on its own, if you're aware of an important piece of information, like a **.instructions.md** file, then absolutely add it to Copilot's context. This helps set Copilot (and you) up for success.
111108
112109
3. Ensure **Agent** mode is still selected.
113-
114-
![Screenshot showing an example of switching to Agent Mode](images/copilot-agent-mode-dropdown.png)
115-
116110
4. Ensure **Claude Sonnet 4** is still selected for the model.
117-
5. Prompt Copilot to implement the functionality based on the issue we created earlier by using the following prompt, replacing **<YOUR_REPOSITORY_PATH>** with the organization/name of your repository which you noted earlier:
111+
5. Prompt Copilot to implement the functionality based on the issue we created earlier by using the following prompt:
118112

119113
```plaintext
120-
Please update the site to include filtering by publisher and category based on the requirements from the related GitHub issue in the backlog of <YOUR_REPOSITORY_PATH>.
114+
Please update the site to include filtering by publisher and category based on the requirements from the related GitHub issue in the backlog.
121115
```
122116

123117
6. Watch as Copilot begins by exploring the project, locating the files associated with the desired functionality. You should see it finding both the API and UI definitions, as well as the tests. It then begins modifying the files and running the tests.
@@ -160,10 +154,10 @@ With our changes created locally we're ready to create a pull request (PR) to al
160154
There are several ways to create a pull request, including through github.com and the GitHub command-line interface (CLI). But since we're already working with GitHub Copilot, let's let it create the PR for us! We can have it find the relevant issue and create the PR with an association to the located issue.
161155

162156
1. Navigate to the Copilot Chat panel and select **New Chat** to start a new session.
163-
2. Ask Copilot to create a PR for you, replacing **<YOUR_REPOSITORY_PATH>** with the organization/name of your repository which you noted earlier:
157+
2. Ask Copilot to create a PR for you:
164158

165159
```plaintext
166-
Find the issue related to filtering by category and publisher on <YOUR_REPOSITORY_PATH>. Create a new pull request for the current add-filters branch, and associate it with the correct issue.
160+
Find the issue in the repo related to filtering by category and publisher. Create a new pull request for the current add-filters branch, and associate it with the correct issue.
167161
```
168162

169163
3. As needed, select **Continue** to allow Copilot to perform the tasks necessary to gather information and perform operations.

0 commit comments

Comments
 (0)