Core tools¶
If you haven't worked with code from GitHub, you might need to install some core tools on your workstation.
In addition to the Git source code management program, you need a text editor and a command terminal. You are welcome to use your preferred programs to develop in the way you like. These are our recommendations for new contributors.
- VS Code
- Windows Terminal
- PowerShell
- ScreenToGif
Visual Studio Code¶
Install the Visual Studio Code text editor and review the getting started tutorial. There are also guides for using git and for developing Python.
We recommend this because it is an excellent and mature general purpose programming application with syntax highlighting, debugging, and extensions.
Install with winget
Recommended extensions¶
This table lists useful VS Code extensions for this project.
| Link | Reason |
|---|---|
| donjayamanne.git-extension-pack | View and search file history Adds project manager to left-side activity bar |
| ms-python.python | Adds navigation and API suggestions Adds Python debugging and refactoring |
| bierner.github-markdown-preview | Apply GitHub's style to your markdown files |
| charliermarsh.ruff | Lint and format Python code on file-save |
| tamasfe.even-better-toml | Syntax highlighting and validation for toml files |
| ms-toolsai.jupyter | Use your own venv as a Jupyter kernel |
Recommended settings¶
- Enable
editor.smoothScrolling - Enable
diffEditor.experimental.showMoves - Enable
diffEditor.experimental.useTrueInlineView - Enable
files.insertFinalNewline - Enable
files.trimFinalNewlines - Enable
files.trimTrailingWhitespace - Enable
workbench.list.smoothScrolling - Enable
terminal.integrated.copyOnSelection - Enable
terminal.integrated.smoothScrolling - Enable
terminal.integrated.stickyScroll.enabled
Windows Terminal¶
Install the Windows Terminal application and configure it for your preferences.
We recommend this because it hosts shells in tabs like a web browser and supports typical copy-paste actions.
Recommended settings¶
- Automatically copy selection to clipboard
- CaskaydiaCove Nerd Font font face
To use this font in VS Code:
- Set
terminal.integrated.fontFamily - to
CaskaydiaCove Nerd Font Mono
PowerShell¶
Optionally, install PowerShell. This new version is named pwsh and installs side-by-side with the system's powershell console.
We recommend this because it's the newest and fastest shell for Windows.
Recommended modules¶
After installing these, apply their usage instructions to the file returned by $profile.
To use these modules in VS Code:
- Set
terminal.integrated.defaultProfile.windows - to
PowerShell - Apply the same changes to the VS Code profile returned by
$profile
ScreenToGif¶
Optionally, install the ScreenToGif application. This tool records both the screen and mouse clicks.
We recommend this because its recordings help demonstrate program behavior.
Git¶
Install Git for Windows and keep the default options in the installer dialog pages.
Optionally, install GitHub Desktop and authenticate with GitHub.
We recommend GitHub Desktop because it is designed to be an application for git and GitHub actions.
Install with winget
Practical exercises¶
- Complete the full pull request workflow tutorial to create your own profile README from your browser.
- Repeat the tutorial using GitHub Desktop and update your profile README page.
- Repeat the tutorial using Visual Studio Code and update your profile README page.
- Repeat the tutorial using git commands when possible and update your profile README page.
- Choose another tutorial from the GitHub skills collection.