Skip to content

Commit 500201d

Browse files
committed
fix: update README with improved image descriptions and add new images for better understanding
1 parent 0e7ad16 commit 500201d

File tree

11 files changed

+24
-29
lines changed

11 files changed

+24
-29
lines changed

Using-GitHub-Copilot-with-CSharp/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ Review the suggestions from Copilot and verify the output. **Note:** It is impor
162162
**Note:** In the case that you do not see [Next Edit Suggestions](https://code.visualstudio.com/blogs/2025/02/12/next-edit-suggestions) appear in your editor, check that they are enabled in your editor.
163163
164164
<div align="left">
165-
<img src="./images/NextEdit.gif" alt="Output of /Explain" width="500" height="300">
165+
<img src="./images/NextEdit.gif" alt="Next Edit Feature" width="500" height="300">
166166
</div>
167167

168168
In the above exercises we achieved the following:
@@ -205,13 +205,13 @@ When executing in Agent mode, Copilot will take a bit longer to work through all
205205
But where Agent mode really shines is that it will iterate on its own output until it resolves errors and reaches a working solution. As agent mode is running, we can see it is running tests to check and verify its own code:
206206

207207
<div align="left">
208-
<img src="./images/agentmodetests.gif" alt="Output Agent Mode Implementation" width="500" height="300">
208+
<img src="./images/agentmodetests.gif" alt="Output Agent Mode Tests" width="500" height="300">
209209
</div>
210210

211211
While Agent Mode is working, we can also view that it has created documentation per our requirements outlined in the tasks that it was given:
212212

213213
<div align="left">
214-
<img src="./images/011agentmodedocs.jpg" alt="Output Agent Mode Implementation" width="500" height="300">
214+
<img src="./images/011agentmodedocs.jpg" alt="Output Agent Mode Documentation" width="500" height="300">
215215
</div>
216216

217217
For this step in the workshop, agent mode should have taken several minutes to complete your tasks. Review the various changes and confirm that they have achieved all of the given output. With Agent mode, it also outputs what changes were made. The following summary of changes that were made are summarized below:
@@ -263,6 +263,10 @@ Agent Mode was able to perform C# specific tasks:
263263

264264
### 🗒️ Section 4: Customization and Context
265265

266+
🎯 Learning Goals
267+
- Understand the different ways to customize GitHub Copilot and receive better responses from prompts.
268+
- Understand the role of Model Context Protocol (MCP).
269+
266270
**Part 1: Custom Instructions**
267271

268272
GitHub Copilot instructions files are markdown documents that provide essential context to guide Copilots behavior within a specific codebase. These files help tailor AI-generated suggestions to match your teams coding standards, architectural patterns, naming conventions, testing strategies, and deployment practices. There are two types of instructions files: global instructions, which apply to the entire repository and are stored in `copilot-instructions.md`, and scoped instructions, which apply only to specific files or folders and are placed in `.github/instructions/*instructions.md`.

Using-GitHub-Copilot-with-Python/README.md

Lines changed: 17 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ To get started:
7575
4. As a visual learner, you can ask GitHub Copilot to 'create a diagram of the workflow of the application'. This could be saved into a README for further documentation.
7676

7777
<div align="left">
78-
<img src="./images/003diagramoutput.gif" alt="Output of application diagram" width="500" height="300">
78+
<img src="./images/003diagramoutput.gif" alt="Output of Mermaid syntax" width="500" height="300">
7979
</div>
8080

8181
In the above exercises we achieved the following:
@@ -100,9 +100,8 @@ In the previous section you learned how to use both natural language or slash co
100100

101101
The output should be similar to this:
102102

103-
TODO
104103
<div align="left">
105-
<img src="./images/004.jpg" alt="changes to existing record" width="500" height="300">
104+
<img src="./images/004pydanticmodel.jpg" alt="Create a Pydantic model" width="500" height="300">
106105
</div>
107106

108107
2. Now we want to use the inline feature of Copilot. When using the inline feature we can focus on the code in front of us and make progressive changes in our code base. Next, we are going to generate a new endpoint at the bottom of the `main.py` file. Place your cursor under the last route that was created and prest `CTRL + I` to open inline chat. Type or copy in the following text:
@@ -111,9 +110,8 @@ TODO
111110
# Create a FastAPI endpoint that accepts a POST request with a JSON body containing a single field called "text" and returns a checksum of the text
112111
```
113112

114-
TODO
115113
<div align="left">
116-
<img src="./images/007customerfile.png" alt="New file customer.cs" width="500" height="300">
114+
<img src="./images/005inlinefastapi.gif" alt="Copilt Chat Inline" width="500" height="300">
117115
</div>
118116

119117
3. Accept the suggestion and highlight the block of text that Copilot has outputted. Open the inline prompt window again (`CRTL + I`) and type in:
@@ -122,10 +120,8 @@ TODO
122120
/improve
123121
```
124122

125-
TODO
126-
127123
<div align="left">
128-
<img src="./images/008regexvalid.jpg" alt="Validate Regex" width="500" height="300">
124+
<img src="./images/006improvechecksum.gif" alt="Improve Checksum" width="500" height="300">
129125
</div>
130126

131127
Review the suggestions from Copilot and verify the output. In this instance we combined both the slash command ability and the inline chat feature.**Note:** It is important to always verify the output from Copilot.
@@ -148,10 +144,8 @@ Improve the docstring for the checksum_text function with more details and examp
148144

149145
**Note:** In the case that you do not see [Next Edit Suggestions](https://code.visualstudio.com/blogs/2025/02/12/next-edit-suggestions) appear in your editor, check that they are enabled in your editor.
150146

151-
TODO
152-
153147
<div align="left">
154-
<img src="./images/NextEdit.gif" alt="Output of /Explain" width="500" height="300">
148+
<img src="./images/007nexteditpython.jpg" alt="Next Edits" width="500" height="300">
155149
</div>
156150

157151
In the above exercises we achieved the following:
@@ -169,10 +163,8 @@ In the above exercises we achieved the following:
169163

170164
1. Open GitHub Copilot Chat. Notice in the text box you can 'add context', which allows you to attach files, folders and other items to the context of Copilot so that it can better understand your codebase. Agent mode should be selected by default. You have the capability to choose your model as well. Also note, the open tab `main.py` and is being referenced to for context.
171165

172-
TODO -- Agent View
173-
174166
<div align="left">
175-
<img src="./images/009agentview.jpg" alt="Output of /Explain" >
167+
<img src="./images/008agentmodechat.jpg" alt="Agent Mode Chat" >
176168
</div>
177169

178170
2. Give Agent mode a detailed prompt. For this example we are going to ask Copilot to make several improvements to our project. Copy and paste the prompt below into the Chat window.
@@ -184,28 +176,21 @@ TODO -- Agent View
184176
4. Make this application deployment ready
185177
5. Improve the performance and security of this application.
186178
```
179+
187180
When executing in Agent mode, Copilot will take a bit longer to work through all of the tasks. It will first parse your intent from the prompt above. It will plan and execute the various tasks.
188181

189-
TODO; Plan
190182
<div align="left">
191-
<img src="./images/010agentbackimplement.jpg" alt="Output Agent Mode Implementation" width="500" height="300">
183+
<img src="./images/009agentmodeplanpython.jpg" alt="Output Agent Mode Implementation" width="500" height="300">
192184
</div>
193185

194186
But where Agent mode really shines is that it will iterate on its own output until it resolves errors and reaches a working solution. As agent mode is running, we can see it is running tests to check and verify its own code:
195187

196-
197-
TODO: test and verify
198188
<div align="left">
199-
<img src="./images/agentmodetests.gif" alt="Output Agent Mode Implementation" width="500" height="300">
189+
<img src="./images/010agentmodetestspy.gif" alt="Output Agent Mode Tests" width="500" height="300">
200190
</div>
201191

202192
While Agent Mode is working, we can also view that it has created documentation per our requirements outlined in the tasks that it was given:
203193

204-
TODO: DOCS
205-
<div align="left">
206-
<img src="./images/011agentmodedocs.jpg" alt="Output Agent Mode Implementation" width="500" height="300">
207-
</div>
208-
209194
For this step in the workshop, agent mode should have taken several minutes to complete your tasks. Review the various changes and confirm that they have achieved all of the given output. With Agent mode, it also outputs what changes were made. The following summary of changes that were made are summarized below:
210195

211196
```md
@@ -249,6 +234,9 @@ For this step in the workshop, agent mode should have taken several minutes to c
249234
```bash
250235
https://< your codespace url >.app.github.dev
251236
```
237+
<div align="left">
238+
<img src="./images/011endpoint.jpg" alt="Endpoint URL">
239+
</div>
252240

253241
🚀Congratulations! Now you understand the power behind Agent Mode and the many tasks that it can help with. Scroll down to the next section that will show you how to add context and customization to Copilot.
254242

@@ -261,6 +249,10 @@ Agent Mode was able to perform C# specific tasks:
261249

262250
### 🗒️ Section 4: Customization and Context
263251

252+
🎯 Learning Goals
253+
- Understand the different ways to customize GitHub Copilot and receive better responses from prompts.
254+
- Understand the role of Model Context Protocol (MCP).
255+
264256
**Part 1: Custom Instructions**
265257

266258
GitHub Copilot instructions files are markdown documents that provide essential context to guide Copilot’s behavior within a specific codebase. These files help tailor AI-generated suggestions to match your team’s coding standards, architectural patterns, naming conventions, testing strategies, and deployment practices. There are two types of instructions files: global instructions, which apply to the entire repository and are stored in `copilot-instructions.md`, and scoped instructions, which apply only to specific files or folders and are placed in `.github/instructions/*instructions.md`.
@@ -276,9 +268,8 @@ Let's create our first global custom instructions file!
276268

277269
1. Create a `copilot-instructions.md` file in the `.github` directory:
278270

279-
TODO
280271
<div align="left">
281-
<img src="./images/012instructionsfile.jpg" alt="Instructions File Location" width="300" height="500" >
272+
<img src="./images/012instructionpy.jpg" alt="Instructions File Location" width="300" height="500" >
282273
</div>
283274

284275
The example below can be customized in your own project, for this example we've created an instructions file specific to our C# requirements in this project.
265 KB
Loading
8.1 MB
Loading
9.48 MB
Loading
266 KB
Loading
233 KB
Loading
299 KB
Loading
7.21 MB
Loading
52.3 KB
Loading

0 commit comments

Comments
 (0)