README

GitHub Copilot instruction files

This folder is reserved for GitHub Copilot instruction files (*.instructions.md). These files provide topic-specific conventions that GitHub Copilot follows when working in this repository - such as writing style, coding patterns, terminology, and formatting rules.

Instruction files are excluded from version control via .gitignore because they are highly personal - they reflect individual workflows, preferences, and conventions that vary from person to person. Adding instruction files to this folder is entirely optional and should be done by the user.

For more details on creating your own instruction files, see the Copilot configuration wiki page.

This work is licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Home

Part 1 Getting Started

This first part of the guide focuses on getting started with GitHub, Git, and Visual Studio Code. It covers the reasons for using these tools, what you need before you start, how to install and set up Visual Studio Code and Git, configuring Git, and useful references for further learning.

Introduction

Why GitHub, Git and Visual Studio Code

What you need before you start

Installing Visual Studio Code and Git

Setting up Visual Studio Code

Configuring Git

Useful references

Part 2 Creating a Repository

Part 2 focuses on creating a repository, including how to create a GitHub repository, initializing Git in a standalone folder, and useful references for further learning.

Creating a GitHub repository

Initializing Git in a standalone folder

Useful references

Part 3 Repository Essentials

Part 3 covers the essentials of working with repositories, including learning Markdown, common repository files, community health files, writing good commit messages, common scenarios for IT professionals, and useful references for further learning.

Learning Markdown

Common repository files

Community health files

Writing good commit messages

Common scenarios for IT professionals

Useful references

Part 4 Branching and Workflows

Part 4 delves into branching and workflows in Git. It covers the basics of Git branches, how to clone a repository, using multi-root workspaces in Visual Studio Code, working with branches, and the daily Git workflow. It also includes useful references for further learning.

Cloning a repository

Using multi-root workspaces

Working with branches

The daily Git workflow

Useful references

Part 5 Working With Repositories

Part 5 focuses on working with repositories, including understanding GitHub URLs, downloading files from GitHub using PowerShell, referencing files in a repository, and the differences between public and private repositories. It also includes sample scripts, an alternative using GitHub Gist, and useful references for further learning.

Understanding GitHub URLs

Downloading files from GitHub using PowerShell

Referencing files in a repository

Public vs. private repositories

Sample scripts

GitHub Gist as an alternative

Useful references

Part 6 AI as a Learning Companion

Part 6 explores how to use AI, specifically GitHub Copilot, as a learning companion to enhance your coding experience. It covers the basics of Vibe Coding, how to get started with GitHub Copilot, and practical tips for writing effective prompts and validating AI-generated code. It also includes guidelines for using AI-assisted coding and references for further learning.

What is Vibe Coding?

Getting started with GitHub Copilot

Your first Copilot conversation

Writing effective prompts

Generating and understanding a script

Learning a new concept through AI

Validating AI-generated code

Using logs and AI to troubleshoot and optimize

Guidelines for AI-assisted coding

Useful references

Part 7 Copilot Configuration

Part 7 focuses on configuring GitHub Copilot to enhance your coding experience. It covers how to create and use copilot-instructions.md files to provide context and guidance to Copilot, as well as best practices for sharing instructions across repositories.

Adding copilot-instructions.md to your repository

Sharing instructions across repositories

Useful references

Part 8 Field Notes

Part 8 is a collection of field notes, which are practical insights and tips that I've gathered through my experience working with GitHub, Git, Visual Studio Code, and GitHub Copilot. These notes are meant to provide additional context and guidance on specific topics that may not have been covered in depth in the previous parts.

Extension recommendations in multi-root workspaces

Copilot instructions and the GitHub Wiki sidebar

GitHub Wiki does not support branch switching

Launching Windows Sandbox from Visual Studio Code

Mirroring wiki pages into the main repository

Useful references

Part 9 Exercises

This is the exercises section! This is where you can apply what you've learned in the previous parts through practical exercises. Each exercise is designed to reinforce key concepts and skills related to GitHub, Git, and Visual Studio Code.

Prerequisites

Part 1 - Getting started

Part 2 - Creating a repository

Part 3 - Repository essentials

Part 4 - Branching and workflows

Part 5 - Working with repositories

Part 6 - AI as a learning companion

Part 7 - Copilot configuration

What to do next

Useful references

Revision