Skip to content

Commit 13f4735

Browse files
committed
fix: update wording for clarity and add new image to README
1 parent b12ebaf commit 13f4735

File tree

3 files changed

+52
-5
lines changed

3 files changed

+52
-5
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ By the end of this module, you'll acquire the skills to be able to:
3030

3131
1. Enable your [GitHub Copilot service](https://github.com/github-copilot/signup)
3232

33-
1. Get familiar with [this repository with Codespaces](https://github.com/github/dotnet-codespaces)
33+
1. Open [this repository with Codespaces](https://github.com/github/dotnet-codespaces)
3434

3535
## 💪🏽 Exercise
3636

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

Lines changed: 51 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ Prepare to tackle a practical, hands-on project! You’ll work on modifying a Py
1010

1111

1212
- **Who this is for**: Developers, DevOps Engineers, Software development managers, Testers.
13-
- **What you'll learn**: Using GitHub Copilot to create code and add comments to your work.
13+
- **What you'll learn**: How to use GitHub Copilot to for code completion, inline suggestions and next edit suggestions, as well as adding comments to your work.
1414
- **What you'll build**: Python files that will have code generated by Copilot AI for code and comment suggestions.
1515
- **Prerequisites**: GitHub Copilot is available to use for free, sign up for [GitHub Copilot](https://gh.io/copilot).
1616
- **Timing**: This module can be completed in under an hour.
1717

18-
By the end of this module, you'll aquire the skills to be able to:
18+
By the end of this module, you'll acquire the skills to be able to:
1919

20-
- Craft prompts to generate suggestions from GitHub Copilot
20+
- Engage with Copilot in the IDE using inline suggestions and next-edit completions.
21+
- Craft prompts to generate suggestions from GitHub Copilot using code completion and chat.
2122
- Apply GitHub Copilot to improve your projects.
2223

2324
## Prerequisite reading:
@@ -27,7 +28,8 @@ By the end of this module, you'll aquire the skills to be able to:
2728
## Requirements
2829

2930
1. Enable your [GitHub Copilot service](https://github.com/github-copilot/signup)
30-
1. Open [this repository with Codespaces](https://codespaces.new/MicrosoftDocs/mslearn-copilot-codespaces-python)
31+
32+
2. Open [this repository with Codespaces](https://codespaces.new/MicrosoftDocs/mslearn-copilot-codespaces-python)
3133

3234
## 💪🏽 Exercise
3335

@@ -37,6 +39,51 @@ By the end of this module, you'll aquire the skills to be able to:
3739

3840
The API already has a single endpoint to generate a token. Let's update the API by adding a new endpoint that accepts text and returns a list of tokens.
3941

42+
### 🗒️ Section 1: Exploring Your Project
43+
44+
🎯**Learning Goals**
45+
- Use inline code completion to scaffold new classes and methods
46+
- Trigger and refine Copilot completions
47+
- Use inline chat and slash commands
48+
49+
Once your Codespace launches, you'll have a fully functional development environment with the entire repository preloaded. This is the perfect time to explore GitHub Copilot Chat to help you better understand the codebase.
50+
51+
To get started:
52+
53+
1. Click the Copilot Chat icon in the top-right corner of the Codespace window:
54+
55+
<div align="left">
56+
<img src="./images/001Chat.jpg" alt="Open GitHub Copilot Chat" width="500" height="300">
57+
</div>
58+
59+
2. Instead of manually exploring the project and various folders, try asking Copilot for an overview. In the chat pane, type '/' to view available slash commands — these offer quick, structured ways to interact with Copilot.
60+
61+
Type `/help` to see all commands, or check out the [GitHub Copilot Chat cheat sheet](https://docs.github.com/copilot/reference/github-copilot-chat-cheat-sheet#slash-commands) for a list of available slash commands.
62+
63+
For example, you can use:
64+
- `/doc` to add a documentation comment
65+
- `/explain` to explain the code
66+
- `/fix` to propose a fix for the problems in the selected code
67+
- `/generate` to generate code to answer your question
68+
69+
3. In lieu of using natural language, type `/explain` into the chat pane. The output from GitHub Copilot will go into details of how the project is structured, including further information of the Frontend and Backend details.
70+
71+
TODO: GIF
72+
<div align="left">
73+
<img src="./images/002explainoutput.gif" alt="Output of /Explain" width="500" height="300">
74+
</div>
75+
76+
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.
77+
78+
TODO: GIF
79+
<div align="left">
80+
<img src="./images/movingdiagram.gif" alt="Output of application diagram" width="500" height="300">
81+
</div>
82+
83+
In the above exercises we achieved the following:
84+
- ✅ Used slash commands to explain new code
85+
- ✅ Created a diagram to visualize and understand the application flow
86+
-
4087
### 🛠 Step 1: Add a Pydantic model
4188

4289
Go to the `main.py` file, navigate to the bottom of the provided code, select **Ctrl + I (PC)** or **Cmd + I (Mac)** and copy the following into the provided GitHub Copilot Chat box so that it can generate a `Pydantic` model for you:
763 KB
Loading

0 commit comments

Comments
 (0)