An open API service indexing awesome lists of open source software.

https://github.com/jacobwoffenden/github-copilot

A collection of notes and configuration for using GitHub Copilot :copilot:
https://github.com/jacobwoffenden/github-copilot

github-copilot

Last synced: 8 months ago
JSON representation

A collection of notes and configuration for using GitHub Copilot :copilot:

Awesome Lists containing this project

README

          

# GitHub Copilot

[![Open in Dev Container](https://raw.githubusercontent.com/ministryofjustice/.devcontainer/refs/heads/main/contrib/badge.svg)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/jacobwoffenden/github-copilot) [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/jacobwoffenden/github-copilot)

A collection of notes and configuration for using [GitHub Copilot](https://github.com/features/copilot) :copilot:

## Table of Contents

- [GitHub Copilot on the web](#github-copilot-on-the-web)
- [Chat on GitHub.com](#chat-on-githubcom)
- [Agents](#agents)
- [Spaces](#spaces)
- [Spark](#spark)
- [MCP Registry](#mcp-registry)
- [GitHub Copilot CLI](#github-copilot-cli)
- [Visual Studio Code](#visual-studio-code)
- [Chat in Visual Studio Code](#chat-in-visual-studio-code)
- [MCP](#mcp)
- [GitHub Copilot Instructions](#github-copilot-instructions)

## GitHub Copilot on the web

There are several options available for using GitHub Copilot on the web:

### Chat on GitHub.com

https://docs.github.com/en/copilot/how-tos/chat-with-copilot/chat-in-github

### Agents

https://docs.github.com/en/copilot/concepts/agents/coding-agent/about-coding-agent

### Spaces

https://docs.github.com/en/copilot/concepts/context/spaces

### Spark

https://docs.github.com/en/copilot/concepts/spark

### MCP Registry

https://github.com/mcp

## GitHub Copilot CLI

https://docs.github.com/en/copilot/concepts/agents/about-copilot-cli

1. Authenticate with GitHub

```bash
gh auth login --git-protocol ssh --skip-ssh-key --web
```

1. Launch GitHub Copilot CLI

```bash
GITHUB_TOKEN=$(gh auth token) copilot
```

![Screenshot of GitHub Copilot CLI interface showing the interactive terminal with command suggestions and completions](contrib/img/copilot-cli.png)

## Visual Studio Code

https://code.visualstudio.com/docs/copilot/overview

### Chat in Visual Studio Code

https://code.visualstudio.com/docs/copilot/chat/copilot-chat

Useful settings:

```json
{
"chat.agent.enabled": true,
"github.copilot.chat.commitMessageGeneration.instructions": [
{
"text": "Use British English spelling."
},
{
"text": "Use conventional commit message format."
}
],
"github.copilot.nextEditSuggestions.enabled": true,
}
```

### MCP

https://code.visualstudio.com/docs/copilot/customization/mcp-servers

An example configuration is available at [`.vscode/mcp.json`](.vscode/mcp.json)

## GitHub Copilot Instructions

This repository includes a [`.github/copilot-instructions.md`](.github/copilot-instructions.md) file that provides custom instructions to GitHub Copilot. This file helps Copilot understand your project's specific conventions, coding standards, and best practices to provide more contextually relevant suggestions.

The instructions file includes guidance on:

- Project overview and technology stack
- Code style and naming conventions
- Testing standards and patterns
- Documentation requirements
- Git practices and commit message formatting
- Security and performance considerations
- Project-specific guidelines and domain logic

GitHub Copilot automatically reads this file when providing suggestions in your repository, ensuring that generated code aligns with your team's standards. You can customize this template to match your project's specific needs.