Skip to content

Commit fb7b555

Browse files
committed
Update GitHub Copilot documentation to clarify tool usage and enhance feature descriptions
1 parent 8b7b22b commit fb7b555

5 files changed

Lines changed: 65 additions & 63 deletions

File tree

learn-pr/wwl-azure/develop-code-features-using-github-copilot-tools/7-knowledge-check.yml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,42 +19,42 @@ quiz:
1919
- content: "Limiting the prompt to coding questions or tasks to enhance the model's output quality."
2020
isCorrect: true
2121
explanation: "Correct. Keeping prompts on topic can help improve the quality of the output generated by GitHub Copilot Chat."
22-
- content: "Using Copilot Chat as a replacement for human programming."
22+
- content: "Using GitHub Copilot Chat as a replacement for human programming."
2323
isCorrect: false
24-
explanation: "Incorrect. Developers should use Copilot Chat as a tool, not a replacement for human programming."
24+
explanation: "Incorrect. Developers should use GitHub Copilot Chat as a tool, not a replacement for human programming."
2525
- content: "Ignoring secure coding and code review practices."
2626
isCorrect: false
27-
explanation: "Incorrect. Developers should follow secure coding and code review practices when using Copilot Chat."
27+
explanation: "Incorrect. Developers should follow secure coding and code review practices when using GitHub Copilot Chat."
2828
- content: "What is the best way to provide context to GitHub Copilot for better code suggestions?"
2929
choices:
3030
- content: "By keeping all files closed in the editor."
3131
isCorrect: false
32-
explanation: "Incorrect. Having related files open in the editor helps Copilot analyze the context and create appropriate suggestions."
32+
explanation: "Incorrect. Having related files open in the editor helps GitHub Copilot analyze the context and create appropriate suggestions."
3333
- content: "By using complex function names."
3434
isCorrect: false
3535
explanation: "Incorrect. Complex function names can be confusing. Meaningful function names and well-scoped function comments provide better context."
3636
- content: "By providing meaningful function names, specific function comments, and having related files open in the editor."
3737
isCorrect: true
38-
explanation: "Correct. These methods help Copilot understand the context of the task and generate appropriate suggestions."
38+
explanation: "Correct. These methods help GitHub Copilot understand the context of the task and generate appropriate suggestions."
3939
- content: "How can a developer optimize their experience when interacting with GitHub Copilot via chat?"
4040
choices:
4141
- content: "By being vague about the inputs, outputs, APIs, or frameworks they want to use."
4242
isCorrect: false
4343
explanation: "Incorrect. The more specific your prompt, the better the outcome."
4444
- content: "By using chat participants, slash commands, chat variables, and being specific in your prompts."
4545
isCorrect: true
46-
explanation: "Correct. These methods help Copilot understand your intent and provide more targeted and accurate responses."
47-
- content: "By asking Copilot to perform large tasks at once."
46+
explanation: "Correct. These methods help GitHub Copilot understand your intent and provide more targeted and accurate responses."
47+
- content: "By asking GitHub Copilot to perform large tasks at once."
4848
isCorrect: false
4949
explanation: "Incorrect. It's better to break down a large task into separate, smaller tasks for more accurate responses."
5050
- content: "What is the effect of maintaining a high quality bar in your code when using GitHub Copilot?"
5151
choices:
52-
- content: "Copilot latches on to your code to generate suggestions that follow the existing pattern."
52+
- content: "GitHub Copilot latches on to your code to generate suggestions that follow the existing pattern."
5353
isCorrect: true
54-
explanation: "Correct. High quality code helps Copilot generate relevant and efficient suggestions."
55-
- content: "It confuses Copilot and leads to irrelevant suggestions."
54+
explanation: "Correct. High quality code helps GitHub Copilot generate relevant and efficient suggestions."
55+
- content: "It confuses GitHub Copilot and leads to irrelevant suggestions."
5656
isCorrect: false
57-
explanation: "Incorrect. High quality code helps Copilot generate suggestions that follow the existing pattern."
57+
explanation: "Incorrect. High quality code helps GitHub Copilot generate suggestions that follow the existing pattern."
5858
- content: "It slows down the suggestion process."
5959
isCorrect: false
6060
explanation: "Incorrect. Maintaining high quality doesn't slow down the suggestion process, but rather improves it."

learn-pr/wwl-azure/develop-code-features-using-github-copilot-tools/includes/2-examine-code-development-features-github-copilot.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Providing GitHub Copilot Chat with prompts or questions that include a clear sco
5050
You can use chat participants, slash commands, and chat variables to clarify the context of your prompts.
5151

5252
- Chat participants, such as `@workspace` or `@terminal`, help GitHub Copilot Chat understand the context of your question.
53-
- Slash commands, such as `/explain` or `/new`, help Copilot Chat understand the intent or purpose of your question.
53+
- Slash commands, such as `/explain` or `/new`, help GitHub Copilot Chat understand the intent or purpose of your question.
5454
- Chat variables, such as `#file` or `#editor`, help Copilot Chat focus on something specific when considering the larger context of your question.
5555

5656
Using these specialized descriptors helps GitHub Copilot Chat generate more accurate and useful responses.
@@ -65,7 +65,7 @@ GitHub Copilot can scaffold more complex workspaces. For example, the following
6565

6666
The Chat view in Visual Studio Code provides access to an AI assistant that helps you develop code. You can ask questions and get help from your AI assistant without leaving the Visual Studio Code environment. The Chat view provides assistance when you're developing code and when you're exploring approaches to solving difficult coding problems. You can also use the Chat view to ask questions about existing code, to get help with errors or coding logic, and to get information about using project resources. The Chat view can help you learn new coding techniques, explore different coding styles, and improve your coding skills.
6767

68-
The Chat view opens in its own panel to the right of Visual Studio Code's code editor. To open the Chat view, select **Open Chat** from the Visual Studio Code Command Center or use the **Ctrl+Alt+I** keyboard shortcut.
68+
The Chat view opens in its own panel to the right of Visual Studio Code's code editor. To open the Chat view, select **Chat** from the Visual Studio Code title bar or use the **Ctrl+Alt+I** keyboard shortcut.
6969

7070
![Screenshot showing the Chat view "welcome" message in Visual Studio Code.](../media/chat-view-1.png)
7171

@@ -91,13 +91,13 @@ GitHub Copilot maintains a history of your conversation. The history is used to
9191

9292
Depending on your question, GitHub Copilot Chat may return source code in the response. Source code is displayed as a code block, and you can manage the code in a few different ways.
9393

94-
If you hover the mouse pointer over the code block, options for managing the code block are displayed. Your initial options are **Apply in Editor**, **Insert At Cursor (Ctrl+Enter)**, and **Copy**.
94+
If you hover the mouse pointer over the code block, options for managing the code block are displayed. Your initial options are **Apply**, **Insert (Ctrl+Enter)**, and **Copy**.
9595

9696
![Screenshot showing a code block in the Chat view.](../media/chat-view-4.png)
9797

9898
The More Actions (...) button displays the options to **Insert into Terminal (Ctrl+Alt+Enter)** and **Insert into New File**.
9999

100-
If Copilot Chat detects that a code block contains a command, you can run it directly in the integrated terminal with **Insert into Terminal (Ctrl+Alt+Enter)**. This option creates or opens the active terminal and inserts the command text, ready for you to run.
100+
If GitHub Copilot Chat detects that a code block contains a command, you can run it directly in the integrated terminal with **Insert into Terminal (Ctrl+Alt+Enter)**. This option creates or opens the active terminal and inserts the command text, ready for you to run.
101101

102102
![Screenshot showing the Insert into Terminal option in the Chat view.](../media/chat-view-6.png)
103103

@@ -123,7 +123,7 @@ You can create a new code feature using inline chat by completing the following
123123

124124
1. Enter a prompt that describes the feature you want to create.
125125

126-
1. Review the suggestions provided by Copilot Chat, and refine your prompt if necessary.
126+
1. Review the suggestions provided by GitHub Copilot Chat, and refine your prompt if necessary.
127127

128128
1. Once you're satisfied, accept a suggestion.
129129

@@ -145,15 +145,15 @@ You can create a regular expression using inline chat by completing the followin
145145

146146
1. Enter a prompt that describes the data pattern you need to validate.
147147

148-
1. Review the suggestions provided by Copilot Chat, and once you're satisfied, accept a suggestion.
148+
1. Review the suggestions provided by GitHub Copilot Chat, and once you're satisfied, accept a suggestion.
149149

150150
Here's an example that demonstrates how to create a regular expression for email addresses using inline chat:
151151

152152
![Screenshot showing an inline chat session used to create a regular expression.](../media/inline-chat-code-suggestion-2.png)
153153

154154
It's always important to review the responses generated by GitHub Copilot Chat.
155155

156-
Copilot Chat suggests the following regular expression can be used to validate email addresses: `^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$`.
156+
GitHub Copilot Chat suggests the following regular expression can be used to validate email addresses: `^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$`.
157157

158158
Let's take a minute to evaluate the suggested regular expression.
159159

0 commit comments

Comments
 (0)