You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Instructions/Labs/m02-ghcopilot-document-explain.md
+25-27Lines changed: 25 additions & 27 deletions
Original file line number
Diff line number
Diff line change
@@ -101,41 +101,39 @@ Your colleague has developed an initial version of the library application and h
101
101
102
102
- Download the zip file.
103
103
- Extract the code files.
104
-
- Ensure that the solution builds in your development environment.
104
+
- Ensure that the solution builds in your lab environment.
105
105
106
106
Use the following steps to set up the library application:
107
107
108
-
1. To download the zip file containing your code project, selectthe following URL: [GitHub Copilot lab - Analyze and document code](https://github.com/MicrosoftLearning/mslearn-github-copilot-dev/raw/refs/heads/main/DownloadableCodeProjects/Downloads/AZ2007M2SamplesZip.zip)
108
+
1. To download a zip file containing the library application, selectthe 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)
109
109
110
-
1. Unzip the downloaded project files.
110
+
The zip file is named **AZ2007LabAppM2.zip**.
111
111
112
-
Unzip the code project in your development environment. For example:
112
+
1. Extract the files from the **AZ2007LabAppM2.zip** file.
113
113
114
-
1. On your local machine, navigate to your downloads folder.
114
+
For example:
115
115
116
-
1. Right-click **GuidedProjectApp.zip**, and thenselect**Extract all**.
116
+
1. Navigate to the downloads folder in your lab environment.
117
117
118
-
1. Select**Show extracted files when complete**, and thenselect**Extract**.
118
+
1. Right-click**AZ2007LabAppM2.zip**, and thenselect**Extract all**.
119
119
120
-
1. Make note of the extracted folder location.
120
+
1. Select **Show extracted files when complete**, and thenselect**Extract**.
121
121
122
-
1. Copy the extracted **GuidedProjectApp** folder to a location that easy to access, such as your Windows Desktop folder.
122
+
1. Open the extracted files folder, then copy the **AccelerateDevGHCopilot_M2** folder to a location that's easy to access, such as your Windows Desktop folder.
123
123
124
-
1. Open the **AccelerateDevGitHubCopilot** folder in Visual Studio Code.
124
+
1. Open the **AccelerateDevGHCopilot_M2** folder in Visual Studio Code.
125
125
126
126
For example:
127
127
128
-
1. Open Visual Studio Code on your PC.
128
+
1. Open Visual Studio Code in your lab environment.
129
129
130
130
1. In Visual Studio Code, on the **File** menu, select **Open Folder**.
131
131
132
-
1. Navigate to the Windows Desktop folder, open the **GuidedProjectApp** folder, and locate the **AccelerateDevGitHubCopilot** folder.
133
-
134
-
1. Select **AccelerateDevGitHubCopilot** and thenselect**Select Folder**.
132
+
1. Navigate to the Windows Desktop folder, select **AccelerateDevGHCopilot_M2** and then select **Select Folder**.
135
133
136
134
1. In the Visual Studio Code SOLUTION EXPLORER view, verify the following solution structure:
137
135
138
-
- AccelerateDevGitHubCopilot\
136
+
- AccelerateDevGHCopilot_M2\
139
137
- src\
140
138
- Library.ApplicationCore\
141
139
- Library.Console\
@@ -145,17 +143,17 @@ Use the following steps to set up the library application:
145
143
146
144
1. Ensure that the solution builds successfully.
147
145
148
-
For example, in the SOLUTION EXPLORER view, right-click **AccelerateDevGitHubCopilot**, and thenselect**Build**.
146
+
For example, in the SOLUTION EXPLORER view, right-click **AccelerateDevGHCopilot_M2**, and then select **Build**.
149
147
150
-
You'll see several Warnings, but there shouldn't be any Errors.
148
+
You'll see some Warnings, but there shouldn't be any Errors.
151
149
152
150
## Use GitHub Copilot to explain the library application codebase
153
151
154
152
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 and feature levels.
155
153
156
154
Use the following steps to complete this section of the exercise:
157
155
158
-
1. Ensure that you have the `AccelerateDevGitHubCopilot` solution open in Visual Studio Code.
156
+
1. Ensure that you have the `AccelerateDevGHCopilot_M2` solution open in Visual Studio Code.
159
157
160
158
1. Open the Chat view, and then enter a prompt that uses GitHub Copilot's `@workspace` participant to generate a description of the project.
161
159
@@ -192,7 +190,7 @@ Use the following steps to complete this section of the exercise:
192
190
193
191
Additionally, there are unit tests located in the UnitTests directory, which test the functionality of the core services using the NSubstitute mocking framework and xUnit.
194
192
195
-
The project uses .NET 8.0 and is configured to build and test using GitHub Actions as defined in the build-test.yml file. The solution file is AccelerateDevGitHubCopilot.sln, which includes all the projects and their configurations.
193
+
The project uses .NET 8.0 and is configured to build and test using GitHub Actions as defined in the build-test.yml file. The solution file is AccelerateDevGHCopilot_M2.sln, which includes all the projects and their configurations.
196
194
```
197
195
198
196
1. Use the Solution Explorer view to expand the project folders.
@@ -399,7 +397,7 @@ Use the following steps to complete this section of the exercise:
399
397
400
398
1. Select **Publish to GitHub**.
401
399
402
-
1. Accept the default name for the repository (AccelerateDevGitHubCopilotSelect) and select **Publish to GitHub private repository**.
400
+
1. Name for the repository **AccelerateDevGHCopilot** andthenselect**Publish to GitHub private repository**.
403
401
404
402
> [!NOTE]
405
403
> If you're not signed in to GitHub in Visual Studio Code, you'll be prompted to sign in. Once you're signed in, authorize Visual Studio Code with the requested permissions.
@@ -412,15 +410,15 @@ Use the following steps to complete this section of the exercise:
412
410
413
411
1. Switch to the browser window for your GitHub account.
414
412
415
-
1. Open the new AccelerateDevGitHubCopilot repository in your GitHub account.
413
+
1. Open the new AccelerateDevGHCopilot repository in your GitHub account.
416
414
417
-
If you don't see your AccelerateDevGitHubCopilot repository, refresh the page. If you still don't see the repository, try the following steps:
415
+
If you don't see your AccelerateDevGHCopilot repository, refresh the page. If you still don't see the repository, try the following steps:
418
416
419
417
1. Switch to Visual Studio Code.
420
418
1. Open your notifications (a notification was generated when the new repository was published).
421
419
1. Select **Open on GitHub** to open your repository.
422
420
423
-
1. On the Code tab of your AccelerateDevGitHubCopilot repository, select **Add a README**.
421
+
1. On the Code tab of your AccelerateDevGHCopilot repository, select**Add a README**.
424
422
425
423
1. In the README.md editor, type**Coming soon** and thenselect**Commit changes**.
426
424
@@ -432,7 +430,7 @@ Use the following steps to complete this section of the exercise:
432
430
433
431
The Views and More Actions menu can be opened using the ellipsis in the top-right corner of the Source Control view.
434
432
435
-
1. Open the Explorer view (not Solution Explorer), and then expand the **AccelerateDevGitHubCopilot** folder.
433
+
1. Open the Explorer view (not Solution Explorer), and then expand the **AccelerateDevGHCopilot_M2** folder.
436
434
437
435
1. Open the README.md file.
438
436
@@ -484,7 +482,7 @@ Use the following steps to complete this section of the exercise:
484
482
Library App is a console-based application for managing library operations such as patron management, book loans, and membership renewals. It uses a JSON-based data storage system and provides various services to handle library functionalities.
485
483
486
484
## Project Structure
487
-
- AccelerateDevGitHubCopilot.sln
485
+
- AccelerateDevGHCopilot_M2.sln
488
486
- README.md
489
487
- src
490
488
- `Library.ApplicationCore/`
@@ -565,7 +563,7 @@ Use the following steps to complete this section of the exercise:
565
563
566
564
## Usage
567
565
1. Clone the repository.
568
-
2. Open the solution file AccelerateDevGitHubCopilot.sln in Visual Studio.
566
+
2. Open the solution file AccelerateDevGHCopilot_M2.sln in Visual Studio.
569
567
3. Build the solution to restore dependencies.
570
568
4. Run the `Library.Console` project to start the console application.
571
569
5. Follow the on-screen instructions to search for patrons, view patron details, extend loans, return books, and renew memberships.
@@ -594,7 +592,7 @@ Use the following steps to complete this section of the exercise:
594
592
595
593
To check your work, complete the following steps:
596
594
597
-
1. Open the GitHub repository for the AccelerateDevGitHubCopilot project.
595
+
1. Open the GitHub repository for the AccelerateDevGHCopilot_M2 project.
598
596
599
597
1. Use the **Code** tab to review the updated README.md file.
0 commit comments