Skip to content

Commit 0d41c90

Browse files
authored
chore: Minor cleanup, typos, rewording
1 parent e9b7891 commit 0d41c90

File tree

3 files changed

+19
-31
lines changed

3 files changed

+19
-31
lines changed

.github/steps/1-preparing.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,13 @@ Your most common interactions will likely be:
2121
- **Copilot Edits**: Similar to Copilot Chat, but less conversational and more big picture or goal oriented.
2222

2323
> [!TIP]
24-
> You can learn more about current and preview features in the [GitHub Copilot Features](https://docs.github.com/en/copilot/about-github-copilot/github-copilot-features) documentation.
25-
26-
> [!TIP]
27-
> You can also select different [models](https://docs.github.com/en/github-models) and [extensions](https://github.com/features/copilot/extensions), but that's for a different lesson!
24+
> You can learn more about current and upcoming features in the [GitHub Copilot Features](https://docs.github.com/en/copilot/about-github-copilot/github-copilot-features) documentation. You can also select different [models](https://docs.github.com/en/github-models) and make your own [extensions](https://github.com/features/copilot/extensions), but that's for a different lesson!
2825
2926
### How can I use GitHub Copilot?
3027

3128
As you work, you'll find GitHub Copilot can help out in several places across the website and in your favorite coding environments such as VS Code, Jet Brains, and Xcode! For today's coding though, we will practice with VS Code in a preconfigured development environment known as [Codespace](https://github.com/features/codespaces).
3229

33-
### :keyboard: Activity: Get a project intro from Copilot Chat :robot:
30+
### :keyboard: Activity: Get a project intro from Copilot Chat
3431

3532
Let's start up our development environment, use copilot to learn a bit about the project, and then give it a test run.
3633

@@ -47,10 +44,9 @@ Let's start up our development environment, use copilot to learn a bit about the
4744

4845
1. In the left sidebar, click the extensions tab and verify that the `GitHub Copilot` and `Python` extensions are installed and enabled.
4946

50-
<img width="350" alt="image" src="https://github.com/user-attachments/assets/ef1ef984-17fc-4b20-a9a6-65a866def468" />
51-
52-
<img width="350" alt="image" src="https://github.com/user-attachments/assets/3040c0f5-1658-47e2-a439-20504a384f77" />
47+
<img width="350" alt="copilot extension for VS Code" src="https://github.com/user-attachments/assets/ef1ef984-17fc-4b20-a9a6-65a866def468" />
5348

49+
<img width="350" alt="python extension for VS Code" src="https://github.com/user-attachments/assets/3040c0f5-1658-47e2-a439-20504a384f77" />
5450

5551
1. At the top of VS Code, locate and click the **Copilot icon** to open a Copilot Chat panel.
5652

@@ -60,39 +56,31 @@ Let's start up our development environment, use copilot to learn a bit about the
6056
@workspace Please briefly explain the structure of this project. What should I do to run it?
6157
```
6258

63-
> **Tip**: No need to follow Copilot's recommended steps. We already prepared the environment for you.
59+
> **Note**: It is not necesesary to follow Copilot's recommended instructions. We have already prepared the environment for you.
6460
6561
1. Now that we know a bit more about the project, let's actually try running it! In the left sidebar, select the `Run and Debug` tab and then press the **Start Debugging** icon.
6662

6763
<img width="300" alt="image" src="https://github.com/user-attachments/assets/50b27f2a-5eab-4827-9343-ab5bce62357e" />
6864

69-
1. We want to see our webpage running in a browser, so let's find the url and port. If it isn't visible, expand the the lower panel and select the **Ports** tab.
65+
1. We want to see our webpage running in a browser, so let's find the url and port. If it isn't visible, expand the lower panel and select the **Ports** tab.
7066

7167
1. In the list, find port `8000` and the related link. Hover over the link and select the **Open in browser** icon.
7268

7369
![image](https://github.com/user-attachments/assets/92d5642e-ce99-4a66-850c-2d311a673596)
7470

75-
> **Tip:** If the webpage doesn't open, make sure you still have the program running.
76-
77-
### :keyboard: Activity: Use Copilot to help remember a terminal command :robot:
71+
### :keyboard: Activity: Use Copilot to help remember a terminal command 🙋
7872

7973
Great work! Now that we are familiar with the app and we know it works, let's ask copilot for help starting a branch so we can do some customizing.
8074

8175
1. If not already there, return to VS Code.
8276

8377
1. In the bottom panel, select the **Terminal** tab. On the right side, click the plus `+` sign to create a new terminal window.
8478

85-
> **Tip:** This will avoid stopping the existing debug session that is hosting our web application service.
79+
> **Note:** This will avoid stopping the existing debug session that is hosting our web application service.
8680
87-
1. Within the new terminal window, `right click` and select `Copilot` then `Terminal Inline Chat`.
81+
1. Within the new terminal window, `right click` and select `Copilot` then `Terminal Inline Chat`. Alternately, you can use the keyboard shortcut `Ctrl + I` (windows) or `Cmd + I` (mac).
8882

89-
> **Pro Tip:** You can also open inline chat with the keyboard shortcut `Ctrl + I` (windows) or `Cmd + I` (mac).
90-
91-
1. Let's ask Copilot to help us remember a command we have forgotten, creating a branch and publishing it.
92-
93-
```txt
94-
Hey copilot, how can I create and publish a new Git branch?
95-
```
83+
1. Let's ask Copilot to help us remember a command we have forgotten: creating a branch and publishing it
9684

9785
> **Tip:** This is a simple example, but Copilot is great at providing more tailored commands that might involve loops, pattern matching, file modification, and more! Don't be afraid to ask Copilot for a suggestion. Just remember it is a suggestion and you should always verify it first to be safe.
9886
@@ -113,7 +101,7 @@ Great work! Now that we are familiar with the app and we know it works, let's as
113101

114102
1. After a moment, look in the VS Code lower status bar, on the left, to see the active branch. It should now say `accelerate-with-copilot`. If so, you are all done with this step!
115103

116-
1. Mona should already be busy checking your work. Give her a moment and keep watch of the comments. You will see her respond with progress info and the next lesson.
104+
1. Now that your branch is pushed to GitHub, Mona should already be busy checking your work. Give her a moment and keep watch in the comments. You will see her respond with progress info and the next lesson.
117105

118106
<details>
119107
<summary>Having trouble? 🤷</summary><br/>

.github/steps/2-first-introduction.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ In short, you can think of Copilot like a very focused coworker. To be effective
2020

2121
### :keyboard: Activity: Use Copilot to fix our registration bug :bug:
2222

23-
1. Let's ask Copilot to suggest where our bug might be coming from. Open the Copilot Chat panel and ask the following.
23+
1. Let's ask Copilot to suggest where our bug might be coming from. Open the **Copilot Chat** panel and ask the following.
2424

2525
```text
2626
@workspace Students are able to register twice for an activity. Where could this bug be coming from?
2727
```
2828

2929
1. Now that we know the issue is in the `src/appy.py` file and the `signup_for_activity` method, let's go fix it (semi-manually). We'll start with a comment and let Copilot finish the correction.
3030

31-
1. In VS Code, select the **Navigation** tab to show the project files and open the `src/app.py` file.
31+
1. In VS Code, select the file **Explorer tab** to show the project files and open the `src/app.py` file.
3232

3333
1. Scroll near the bottom of the file and find the `signup_for_activity` method.
3434

@@ -71,9 +71,9 @@ In short, you can think of Copilot like a very focused coworker. To be effective
7171

7272
</details>
7373

74-
### :keyboard: Activity: Let Copilot generate sample data :robot:
74+
### :keyboard: Activity: Let Copilot generate sample data 📋
7575

76-
In new project developments, it's often helpful to have some realistic looking fake data for testing. Copilot is excellent at this task, so let's add some more sample activities and introduce another way to interact with Copilot: **Inline Chat**
76+
In new project developments, it's often helpful to have some realistic looking fake data for testing. Copilot is excellent at this task, so let's add some more sample activities and introduce another way to interact with Copilot using **Inline Chat**
7777

7878
> [!TIP]
7979
> **Inline Chat** and the **Copilot Chat** panel are very similar tools, but with slightly different automatic context. As such, while Copilot Chat is good at explaining about the project, inline chat might feel more natural for asking about a particular line or function.
@@ -161,7 +161,7 @@ activities = {
161161

162162
</details>
163163

164-
### :keyboard: Activity: Use Copilot to describe our work :robot:
164+
### :keyboard: Activity: Use Copilot to describe our work 💬
165165

166166
Nice work fixing that bug and expanding the example activities! Now let's get our work committed and pushed to GitHub, again with the help of Copilot!
167167

@@ -179,7 +179,7 @@ Nice work fixing that bug and expanding the example activities! Now let's get ou
179179

180180
1. To the right of the **Message** text box, find and click the **Generate Commit Message with Copilot** button (sparkles icon).
181181

182-
1. Press the **Commit** button and **Sync Changes** button push your chagnes to GitHub.
182+
1. Press the **Commit** button and **Sync Changes** button to push your changes to GitHub.
183183

184184
1. Wait a moment for Mona to check your work, provide feedback, and share the next lesson.
185185

.github/steps/4-copilot-on-github.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Step 4: Using GitHub Copilot within a pull request
22

3-
Congratulations! You are finished with coding for this exercise. Now it's time to merge our work. :tada: To wrap up, let's learn about two limited-access Copilot features that can speed up our pull requests!
3+
Congratulations! You are finished with coding for this exercise (and VS Code). Now it's time to merge our work. :tada: To wrap up, let's learn about two limited-access Copilot features that can speed up our pull requests!
44

55
#### Copilot Pull Request Summaries
66

@@ -13,7 +13,7 @@ Typically, you would review your notes and commit messages then summarize them f
1313

1414
More eyes on our work is always useful so let's ask Copilot to do a first pass before we do a normal peer review process. Copilot is great at catching common mistakes that can are fixed by simple adjustment, but please remember to use it responsibily.
1515

16-
> [!IMPORTANT]
16+
> [!NOTE]
1717
> This is in **Public Preview** for organizations. [[docs]](https://docs.github.com/en/copilot/using-github-copilot/code-review/using-copilot-code-review)
1818
1919
### :keyboard: Activity: Summarize and review a PR with Copilot

0 commit comments

Comments
 (0)