Skip to content

docs(vscode): Enhance GitHub Copilot tutorial with improved flow, clarity, and student guidance #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs(vscode): Enhance GitHub Copilot tutorial with improved flow, clarity, and student guidance #144

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2ca94be
docs: clarify Copilot setup flow and add student-focused tips
arshinsikka14 Aug 2, 2025
4aaa2cb
docs(vscode): Add @arshinsikka14 as contributor to Copilot tutorial
arshinsikka14 Aug 3, 2025
ab1b4db
docs(vscode): dedupe terminal tip box and keep single clean tip after…
arshinsikka14 Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 26 additions & 5 deletions tutorials/vscCopilot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

GitHub Copilot is an AI Tool that is well-integrated with VS Code, because both tools are from the same parent company (Microsoft).

<include src="copilotGithub.md#prereq" />
<include src="copilotGitHub.md#prereq" />

## Installing GitHub Copilot in Visual Studio Code

Expand Down Expand Up @@ -47,6 +47,12 @@ GitHub Copilot is an AI Tool that is well-integrated with VS Code, because both

## Using GitHub Copilot in Visual Studio Code

The Copilot extension offers multiple ways to interact with AI assistance in VS Code:

- **Copilot Chat** – chat panel for general questions, help, and slash commands (e.g., `/explain`, `/fix`)
- **Inline Chat** – ask Copilot to edit/explain code in place; also supports slash commands
- **Terminal Prompts** – invoke Copilot from the integrated terminal; best for build/run/shell tasks (slash commands work here too)

### Basic Code Completion

**To get Copilot to complete code based on a comment**:
Expand All @@ -68,7 +74,7 @@ GitHub Copilot is an AI Tool that is well-integrated with VS Code, because both

**To disable automatic code completion**,

1. Look for the Copilot icon in the bottom right of vscode:<br>
1. Look for the Copilot icon in the bottom-right of VS Code:<br
<pic src="images/vscCopilotUsage/copilotIconBottomBar.png" width="300" /><br>
1. Uncheck the necessary boxes (`All files` disables code completion for all files, while the checkbox below it disables code completion for the currently open file type.)

Expand Down Expand Up @@ -114,15 +120,30 @@ If you have access to Copilot Pro, you can also monitor your Copilot Premium Req

1. Open a terminal in Visual Studio Code.
1. Press `Ctrl+I` to bring up Copilot’s terminal prompt input.<br>
<pic src="images/vscCopilotUsage/copilotTerminal.png" width="600" />
<box type="tip" seamless>

Slash commands like `/explain` and `/fix` also work in **Copilot Chat** and **Inline Chat**, not just the terminal.
</box>


<box type="tip" seamless>
Slash commands like `/explain` and `/fix` also work in Copilot Chat** and Inline Chat, not just the terminal.
</box>


Some common project-related prompts you might find useful:

* Run the checkstyle
* Compile and run the Java program
* Run JUnit tests
* ~~Perform Git operations~~ (possible but #r#not recommended##; if you are new to Git, we discourage using Git inside the IDE -- it is better for beginners to learn Git independent of other tools)
* ~~Perform Git operations~~ (possible but **not recommended**; if you are new to Git, we discourage using Git inside the IDE — it’s better for beginners to learn Git independent of other tools)
<box type="tip" seamless>

**Troubleshooting Tips**
Copy link
Contributor

@NorbertLoh NorbertLoh Aug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not bolding correctly in the webpage. Perhaps you would need a new line.
image

- Copilot not showing up? → Ensure you are in a Java file and that the extension is installed and enabled.
- Copilot panel missing? → Try restarting VS Code or reinstalling the extension.
</box>

---

**Contributors**: Norbert Loh ([@NorbertLoh ](https://github.com/NorbertLoh )), Luoqi Xu ([@Luoq1-Xu](https://github.com/Luoq1-Xu))
**Contributors**: Norbert Loh ([@NorbertLoh](https://github.com/NorbertLoh)), Luoqi Xu ([@Luoq1-Xu](https://github.com/Luoq1-Xu)), Arshin Sikka ([@arshinsikka](https://github.com/arshinsikka))