Skip to content

Commit 9383911

Browse files
committed
exercise 1 updates
1 parent 8c203d7 commit 9383911

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

Instructions/Labs/LAB_AK_02_analyze_document_code.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Use the following steps to set up the library application:
4040

4141
1. To download a zip file containing the library application, select the following URL: [GitHub Copilot lab - Analyze and document code](https://github.com/MicrosoftLearning/mslearn-github-copilot-dev/raw/refs/heads/main/DownloadableCodeProjects/Downloads/AZ2007LabAppM2.zip)
4242

43-
The zip file is named **AZ2007LabAppM2.zip**.
43+
The zip file is named AZ2007LabAppM2.zip.
4444

4545
1. Extract the files from the **AZ2007LabAppM2.zip** file.
4646

@@ -64,7 +64,7 @@ Use the following steps to set up the library application:
6464

6565
1. Navigate to the Windows Desktop folder, select **AccelerateDevGHCopilot** and then select **Select Folder**.
6666

67-
1. In the Visual Studio Code SOLUTION EXPLORER view, verify the following solution structure:
67+
1. In the Visual Studio Code SOLUTION EXPLORER view, expand the solution to show the following solution structure:
6868

6969
- AccelerateDevGHCopilot\
7070
- src\
@@ -82,7 +82,7 @@ Use the following steps to set up the library application:
8282

8383
## Use GitHub Copilot to explain the library application codebase
8484

85-
It's important to understand an application's architecture and key features before documenting the project. GitHub Copilot can help you to understand an unfamiliar codebase by generating explanations at the solution, file, and code line levels.
85+
GitHub Copilot can help you to understand an unfamiliar codebase by generating explanations at the solution, file, and code line levels.
8686

8787
### Analyze code using prompts in the Chat view
8888

@@ -94,7 +94,7 @@ GitHub Copilot's Chat view includes a chat-based interface that allows you to in
9494

9595
Use the following steps to complete this section of the exercise:
9696

97-
1. Ensure that the **AccelerateDevGHCopilot** solution is open in Visual Studio Code.
97+
1. Ensure that the AccelerateDevGHCopilot solution is open in Visual Studio Code.
9898

9999
1. Open GitHub Copilot's Chat view.
100100

@@ -112,25 +112,25 @@ Use the following steps to complete this section of the exercise:
112112
@workspace describe this project
113113
```
114114
115-
Use Chat participants, such as the **@workspace**, to scope your prompt to a specific domain. Chat participants are like domain experts who have a specialty that they can help you with. Use @workspace when you want GitHub Copilot to consider the structure of your project, how different parts of your code interact, or design patterns in your project.
115+
Use Chat participants, such as the **@workspace**, to scope your prompt to a specific domain. Chat participants work like domain experts who can help you in their specialized areas. Use **@workspace** when you want GitHub Copilot to consider the structure of your project, how different parts of your code interact, or design patterns in your project.
116116
117117
To see a list of all available chat participants, type **@** in the chat prompt box.
118118
119119
1. Take a few minutes to compare GitHub Copilot's response with the actual project files.
120120
121-
You should see a response similar to the following description:
121+
You should see a response that's similar to the following description:
122122
123123
```markdown
124124
125125
This project is a .NET solution named AccelerateDevGHCopilot that appears to be a library and application framework with a modular structure. It is organized into three main components under the *src* directory and a unit testing project under the *tests* directory. Here's a breakdown:
126126
127-
## Solution Structure
127+
**Solution Structure**
128128
129129
- Solution File: AccelerateDevGHCopilot.sln
130130
131131
- Contains references to the projects in the solution.
132132
133-
## Projects
133+
**Projects**
134134
135135
1. Library.ApplicationCore:
136136
@@ -158,7 +158,7 @@ Use the following steps to complete this section of the exercise:
158158
- Uses testing frameworks like xUnit, NSubstitute, and coverlet.collector.
159159
- Targets .NET 8.0.
160160
161-
## Key Features
161+
**Key Features**
162162
163163
- Dependency Injection: The use of Microsoft.Extensions.DependencyInjection suggests that the project employs dependency injection for managing dependencies.
164164
- Configuration Management: The use of Microsoft.Extensions.Configuration and Microsoft.Extensions.Configuration.Json indicates support for configuration management, likely using JSON files.
@@ -169,11 +169,11 @@ Use the following steps to complete this section of the exercise:
169169
170170
1. Use the SOLUTION EXPLORER view to expand the project folders.
171171
172-
1. Locate and open the **ConsoleApp.cs** file.
172+
1. Locate and then open the **ConsoleApp.cs** file.
173173
174174
The ConsoleApp.cs file is located in the **src/Library.Console** folder.
175175
176-
1. Take a minute to examine the code file.
176+
1. Take a moment to review the code file.
177177
178178
1. Enter a prompt in the Chat view that generates a description of the **ConsoleApp** class.
179179
@@ -183,7 +183,7 @@ Use the following steps to complete this section of the exercise:
183183
@workspace #class describe the ConsoleApp class
184184
```
185185
186-
Use chat variables, such as **#class**, to include specific context in your prompt. To see a list of all available chat variables, type **#** in the chat prompt box.
186+
Use chat variables, such as **#class**, to include specific context in your prompt. To see a list of the chat variables, type **#** in the chat prompt box.
187187
188188
> **NOTE**: GitHub Copilot considers your chat history and the code files you have open in Visual Studio Code when constructing a context for your prompt and generating a response.
189189
@@ -195,7 +195,7 @@ Use the following steps to complete this section of the exercise:
195195
196196
The ConsoleApp class in ConsoleApp.cs is responsible for managing the console-based user interface of the library management system. It handles user interactions, processes user inputs, and coordinates actions with the underlying services and repositories.
197197
198-
### Fields
198+
**Fields**
199199
200200
- _currentState: Tracks the current state of the console application.
201201
- matchingPatrons: A list of patrons that match a search query.
@@ -206,11 +206,11 @@ Use the following steps to complete this section of the exercise:
206206
- _loanService: An instance of ILoanService for performing loan-related operations.
207207
- _patronService: An instance of IPatronService for performing patron-related operations.
208208
209-
### Constructor
209+
**Constructor**
210210
211211
- ConsoleApp(ILoanService loanService, IPatronService patronService, IPatronRepository patronRepository, ILoanRepository loanRepository): Initializes the ConsoleApp with the provided services and repositories.
212212
213-
### Methods
213+
**Methods**
214214
215215
- Run(): The main entry point for running the console application.
216216
- PatronSearch(): Handles the logic for searching patrons.
@@ -292,9 +292,9 @@ Use the following steps to complete this section of the exercise:
292292
293293
1. Take a couple minutes to examine the JSON data files that are used to simulate library records.
294294
295-
The JSON data files are located in the `src/Library.Console/Json` folder.
295+
The JSON data files are located in the **src/Library.Console/Json** folder.
296296
297-
The data files use ID properties to link entities. For example, a `Loan` object has a `PatronId` property that links to a `Patron` object with the same ID. The JSON files contain data for authors, books, book items, patrons, and loans.
297+
The data files use ID properties to link entities. For example, a **Loan** object has a **PatronId** property that links to a **Patron** object with the same ID. The JSON files contain data for authors, books, book items, patrons, and loans.
298298
299299
> **NOTE**: Notice that Author names, book titles, and patron names have been anonymized for the purposes of this guided project.
300300

0 commit comments

Comments
 (0)