✨ A curated list of awesome GitHub instructions, prompt and chatmode markdown files for enhancing your GitHub Copilot AI experience.

---

📖 Contribution Guide

Contents

• Why Copilot Instructions
• Instructions
  • Boilerplates & Templates
  • Language & Stack
  • Framework / Library
  • Tools
  • Workflows
• Prompts
  • AI Development Tasks
• Chatmodes
  • AI Development Mode
• How to Use

Why Copilot Instructions

copilot-instructions.md and *.instructions.md files help guide GitHub Copilot by providing contextual details about your repository such as the type of workflow your team follows, tools and other project specific details such as coding style, frameworks used or project specific rules.

Tip: Learn more about Copilot Instructions in the VS Code documentation.

Instructions

Instructions provides Copilot with repository-specific context, such as coding standards, frameworks, or workflows, to improve code suggestions.

Boilerplates & Templates

Templates

• Standard Language Template - Standard language template to build instruction files.

Boilerplate

• Standard IaC Tools Boilerplate - Standard tool boilerplate for infrastructure-as-code tools.

Language & Stack

C

• Standard Focus - System libraries, CLI tools, and embedded applications with POSIX/GNU libc.

C-Sharp

• Standard Focus - .NET applications with modern C# patterns and best practices.

C++

• Standard Focus - Modern C++ development with STL, RAII, and performance optimization.

Go

• Standard Focus - Go for microservices, CLI tools, and concurrent applications.

Java

• Standard Focus - Enterprise Java development with Spring framework and modern patterns.

JavaScript

• Standard Focus - Modern JavaScript with ES6+, Node.js, and browser development.

Kotlin

• Standard Focus - Kotlin for Android development and multi-platform projects.

Lua

• Standard Focus - Lua scripting for embedded systems, game development, and automation.

Python

• Standard Focus - Python development for web applications, data science, and automation.

Rust

• Standard Focus - Systems programming with Rust's ownership model and memory safety.

Swift

• Standard Focus - iOS and macOS development with Swift and SwiftUI.

TypeScript

• Standard Focus - Typescript development for web and Node.js applications.

Framework / Library

Cobra CLI (Go)

• Charmbracelet Bubbles CLI - Interactive terminal applications with Charm's Bubble Tea framework and Golang Cobra CLI.

Node.js (TypeScript)

• Azure Function App - Azure Function Apps using Typescript Node.js.
• Express API - REST API development with Express.js and TypeScript Node.js.

Tools

Content Management Systems (CMS)

Drupal

• Standard Focus for Drupal 11 - Drupal 11 module and theme development.

Infra as Code (IaC)

Terraform

• Standard Focus - Standard terraform instructions.
• Atmos - Terraform workflow orchestration with Atmos framework.

Workflows

AI Development Instructions

A comprehensive workflow for AI-assisted development featuring structured approaches to planning, task generation, and execution.

• PRD Creation - Create detailed Product Requirements Documents.
• Task Generation - Break PRDs into actionable development tasks.
• Task Execution - Systematic task execution with proper testing and git practices.

Prompts

Prompts are reusable tasks or workflow instructions that help guide Copilot to perform specific actions or generate certain outputs.

AI Development Tasks

A comprehensive workflow for AI-assisted development featuring structured approaches to planning, task generation, and execution.

• PRD Creation Prompt - Create detailed Product Requirements Documents using prompt tasks.
• Task Generation Prompt - Break PRDs into actionable development tasks using prompt tasks.
• Task Execution Prompt - Systematic task execution with proper testing and git practices using prompt tasks.

Chatmodes

Chat modes in VS Code are predefined settings that customize the Copilots behavior for tasks like asking questions, editing code, or autonomous coding. You can switch between modes anytime in the Chat view based on your needs.

AI Development Mode

• PRD Creation - Build Product Requirements Document (PRD).

How to Use

Setup Copilot in VSCode

1. Hover over the Copilot icon in the Status Bar and select Set up Copilot.
2. Select Sign in to sign in to your GitHub account or Use Copilot if you're already signed in.

Tip: Read more about setting up VS Code Copilot.

Setup Instructions

1. Create instruction files using the latest naming conventions:
   1. Workspace instructions (place *.instructions.md files in .github/instructions/ directory).
   2. Workspace prompts (place *.prompt.md files in .github/prompts/ directory).
   3. Workspace chat modes (place *.chatmode.md files in .github/chatmodes directory).
   4. Workspace single instruction (place copilot-instructions.md in .github directory).

File Types

Instruction Files

.instructions.md - Contextual instructions that apply to specific files or file types.

Prompt Files

.prompt.md - Reusable prompts for specific tasks or workflows.

Chatmode Files

.chatmode.md - Predefined configurations that enable you to tailor the AI chat behavior in VS Code for specific tasks.

Formatting

Use YAML front matter to specify metadata like applyTo, mode, and description.

Contributing

All contributions are welcome! If you would like to share instruction files (.instructions.md), prompt files (.prompt.md) or chatmodes (.chatmode.md), see the contribution guide for details.