Skip to content

Commit 80128e4

Browse files
committed
Enhance README.md with GitHub Copilot Chat usage instructions and workflow explanations
1 parent 48af1a3 commit 80128e4

1 file changed

Lines changed: 17 additions & 1 deletion

File tree

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

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,30 @@ The "**GitHub Codespaces ♥️ .NET 8**" repository builds a Weather API using
4242

4343
We will review the steps to update the Weather BackEnd App by adding a new endpoint that requests a specific location and returns the weather forecast for that location.
4444

45-
**TEST**
45+
4646
### 🗒️ Step 1: Get familiarized with the "GitHub Codespaces ♥️ .NET 8" repository
4747

4848
Once you open the repository in Codespaces, you will find a new browser window with a fully functional Codespace. Everything in this repository is contained within this one Codespace.
4949
This is a great opportunity to get started with GitHub Copilot Chat right away! We have opened up a new repository and we want to get familiar with it. Navigate to the top of the GitHub Codespace and select the Copilot Chat icon to the right search bar:
5050

5151
![Open GitHub Copilot Chat](./001-chat.jpg001-chat.jpg)
5252

53+
We can use the explorer panel to review the BackEnd and Front projects. Instead, let's use GitHub Copilot to get more familiar with this codebase. GitHub Copilot is designed to use natural language, but it also includes 'slash commands' that allow for a faster way to ask Copilot. In the chat pane, type in a '/' and see the different options available. If you type '/help' you can see the full list of commands available. You can also reference the [slash commands in the GitHub documentation.](https://docs.github.com/en/copilot/reference/github-copilot-chat-cheat-sheet#slash-commands)
54+
55+
Let's first understand our codebase. In the Chat pane type '/explain'. GitHub Copilot will explain how the project is structured, including the Frontend and Backend details.
56+
57+
TODO: Insert gif/video
58+
59+
To go a step further, I ask GitHub Copilot to create a diagram for the workflow of our application so I can better understand how it works together.
60+
61+
62+
Ask GitHub Copilot to run and debug the backend
63+
64+
TODO: add the gif/screenshot
65+
66+
67+
68+
5369

5470
For example, in the explorer panel, we can see the main code for the BackEnd and the FrontEnd projects.
5571

0 commit comments

Comments
 (0)