Skip to main content

About This Catalog

This catalog contains 175+ custom instructions that automatically guide GitHub Copilot to follow best practices, coding standards, and project-specific conventions. Instructions are organized by technology, framework, and use case.
Each instruction includes an applyTo pattern that automatically activates when working with matching files. Click the file name to view the source on GitHub.

Frontend Frameworks

React Ecosystem

React

File: reactjs.instructions.md
Applies to: **/*.jsx, **/*.tsx, **/*.js, **/*.ts, **/*.css, **/*.scss
ReactJS development standards with modern hooks, patterns, and best practices. Includes component design, state management, performance optimization, and testing guidelines.

Next.js

File: nextjs.instructions.md
Applies to: **/*.tsx, **/*.ts, **/*.jsx, **/*.js, **/*.css
Best practices for Next.js App Router with modern caching, tooling, and server/client boundaries (Next.js 16.1.1+).

Next.js + Tailwind

File: nextjs-tailwind.instructions.md
Applies to: **/*.tsx, **/*.ts, **/*.jsx, **/*.js
Combined Next.js and Tailwind CSS patterns for rapid development.

TanStack Start

File: tanstack-start-shadcn-tailwind.instructions.md
Applies to: **/*.tsx, **/*.ts
TanStack Start with shadcn/ui and Tailwind CSS integration.

Angular

Angular

File: angular.instructions.md
Applies to: **/*.ts, **/*.html, **/*.scss, **/*.css
Angular-specific coding standards with Signals for state management, standalone components, and TypeScript best practices. Includes architecture, testing, and performance optimization.

Vue.js

Vue.js 3

File: vuejs3.instructions.md
Applies to: **/*.vue, **/*.ts, **/*.js, **/*.scss
Vue 3 development with Composition API, TypeScript, Pinia state management, and modern patterns. Includes component design, reactivity, and testing.

Other Frontend Frameworks

Svelte

File: svelte.instructions.md
Applies to: **/*.svelte, **/*.ts, **/*.js
Svelte component development patterns and best practices.

Astro

File: astro.instructions.md
Applies to: **/*.astro, **/*.ts, **/*.tsx
Astro development standards for content-driven websites.

Backend Frameworks & Languages

.NET Ecosystem

C#

File: csharp.instructions.md
Applies to: **/*.cs
C# development guidelines with C# 14 features, naming conventions, nullable reference types, and best practices.

ASP.NET REST APIs

File: aspnet-rest-apis.instructions.md
Applies to: **/*.cs
Guidelines for building REST APIs with ASP.NET including authentication, validation, versioning, and documentation.

Blazor

File: blazor.instructions.md
Applies to: **/*.razor, **/*.razor.cs, **/*.razor.css
Blazor component and application patterns for building interactive web UIs with .NET.

.NET MAUI

File: dotnet-maui.instructions.md
Applies to: **/*.xaml, **/*.cs
.NET MAUI component and application patterns for cross-platform mobile development.

.NET Framework

File: dotnet-framework.instructions.md
Applies to: **/*.cs, **/*.vb
Guidance for .NET Framework projects including project structure and NuGet management.

.NET WPF

File: dotnet-wpf.instructions.md
Applies to: **/*.xaml, **/*.cs
WPF application development with MVVM patterns and XAML best practices.

Java & JVM

Java

File: java.instructions.md
Applies to: **/*.java
Java development guidelines with modern language features and best practices.

Spring Boot

File: springboot.instructions.md
Applies to: **/*.java
Spring Boot application development patterns, dependency injection, and REST API design.

Quarkus

File: quarkus.instructions.md
Applies to: **/*.java
Quarkus framework patterns for cloud-native Java applications.

Scala 2

File: scala2.instructions.md
Applies to: **/*.scala
Scala 2 development patterns and functional programming best practices.

Node.js & TypeScript

TypeScript

File: typescript-5-es2022.instructions.md
Applies to: **/*.ts, **/*.tsx
TypeScript 5 with ES2022 features, strict mode, and type-safety patterns.

NestJS

File: nestjs.instructions.md
Applies to: **/*.ts
NestJS framework patterns for building scalable server-side applications.

Node.js + Vitest

File: nodejs-javascript-vitest.instructions.md
Applies to: **/*.js, **/*.ts
Node.js and JavaScript code generation with Vitest testing framework.

Python

Python

File: python.instructions.md
Applies to: **/*.py
Python coding conventions following PEP 8 with type hints, docstrings, and best practices.

LangChain Python

File: langchain-python.instructions.md
Applies to: **/*.py
LangChain development patterns for building LLM applications with Python.

Other Languages

Go

File: go.instructions.md
Applies to: **/*.go
Go development standards and idiomatic patterns.

Rust

File: rust.instructions.md
Applies to: **/*.rs
Rust development with ownership, borrowing, and memory safety patterns.

Ruby on Rails

File: ruby-on-rails.instructions.md
Applies to: **/*.rb, **/*.erb
Ruby on Rails conventions and best practices.

PHP Symfony

File: php-symfony.instructions.md
Applies to: **/*.php
Symfony framework patterns for PHP applications.

Dart & Flutter

File: dart-n-flutter.instructions.md
Applies to: **/*.dart
Dart and Flutter development following official recommendations.

Swift

File: swift-mcp-server.instructions.md
Applies to: **/*.swift
Swift development for MCP server implementation.

Kotlin

File: kotlin-mcp-server.instructions.md
Applies to: **/*.kt
Kotlin development patterns for MCP servers.

Clojure

File: clojure.instructions.md
Applies to: **/*.clj, **/*.cljs
Clojure functional programming patterns and REPL-driven development.

R

File: r.instructions.md
Applies to: **/*.r, **/*.R
R programming for statistical computing and data analysis.

Infrastructure as Code

Terraform

File: terraform.instructions.md
Applies to: **/*.tf
Terraform conventions and guidelines for infrastructure provisioning with security, modularity, and maintainability focus.

Terraform Azure

File: terraform-azure.instructions.md
Applies to: **/*.tf
Azure-specific Terraform patterns and best practices.

Terraform SAP BTP

File: terraform-sap-btp.instructions.md
Applies to: **/*.tf
SAP Business Technology Platform infrastructure with Terraform.

Bicep

File: bicep-code-best-practices.instructions.md
Applies to: **/*.bicep
Infrastructure as Code with Bicep for Azure resources.

Azure Verified Modules (Bicep)

File: azure-verified-modules-bicep.instructions.md
Applies to: **/*.bicep
Azure Verified Modules patterns for Bicep.

Azure Verified Modules (Terraform)

File: azure-verified-modules-terraform.instructions.md
Applies to: **/*.tf
Azure Verified Modules patterns for Terraform.

Ansible

File: ansible.instructions.md
Applies to: **/*.yml, **/*.yaml
Ansible conventions and best practices for automation.

Cloud & DevOps

Azure

Azure Functions TypeScript

File: azure-functions-typescript.instructions.md
Applies to: **/*.ts
TypeScript patterns for Azure Functions serverless development.

Azure DevOps Pipelines

File: azure-devops-pipelines.instructions.md
Applies to: **/*.yml, **/*.yaml
Best practices for Azure DevOps Pipeline YAML files.

Azure Logic Apps & Power Automate

File: azure-logic-apps-power-automate.instructions.md
Applies to: **/*.json
Workflow Definition Language patterns for Logic Apps and Power Automate.

AWS

AWS AppSync Event API

File: aws-appsync.instructions.md
Applies to: **/*.js
AWS AppSync Event API handlers with APPSYNC_JS runtime patterns.

Containerization & Kubernetes

Docker Best Practices

File: containerization-docker-best-practices.instructions.md
Applies to: **/Dockerfile, **/*.dockerfile
Comprehensive Docker best practices for optimized, secure images.

Kubernetes Manifests

File: kubernetes-manifests.instructions.md
Applies to: **/*.yml, **/*.yaml
Kubernetes manifest patterns and best practices.

Kubernetes Deployment

File: kubernetes-deployment-best-practices.instructions.md
Applies to: **/*.yml, **/*.yaml
Best practices for Kubernetes deployments, services, and configurations.

CI/CD

GitHub Actions

File: github-actions-ci-cd-best-practices.instructions.md
Applies to: **/.github/workflows/*.yml, **/.github/workflows/*.yaml
GitHub Actions workflow patterns for CI/CD pipelines.

Database & Data

MongoDB DBA

File: mongo-dba.instructions.md
Applies to: **/*.js, **/*.ts
MongoDB database administration patterns.

MS SQL DBA

File: ms-sql-dba.instructions.md
Applies to: **/*.sql
Microsoft SQL Server administration and T-SQL best practices.

SQL Stored Procedures

File: sql-sp-generation.instructions.md
Applies to: **/*.sql
SQL stored procedure generation patterns.

Testing Frameworks

Playwright TypeScript

File: playwright-typescript.instructions.md
Applies to: **/*.spec.ts, **/*.test.ts
Playwright end-to-end testing with TypeScript.

Playwright Python

File: playwright-python.instructions.md
Applies to: **/*.py
Playwright testing patterns for Python.

Playwright .NET

File: playwright-dotnet.instructions.md
Applies to: **/*.cs
Playwright testing for .NET applications.

PowerShell Pester

File: powershell-pester-5.instructions.md
Applies to: **/*.Tests.ps1
Pester 5 testing framework for PowerShell.

Microsoft Power Platform

Power Apps & PCF

PCF Code Components

File: pcf-code-components.instructions.md
Applies to: **/ControlManifest.Input.xml, **/*.tsx, **/*.ts
PowerApps Component Framework structure and implementation.

PCF Best Practices

File: pcf-best-practices.instructions.md
Applies to: **/*.tsx, **/*.ts
Best practices for developing PCF code components.

PCF Model-Driven Apps

File: pcf-model-driven-apps.instructions.md
Applies to: **/*.tsx, **/*.ts
PCF components for model-driven apps.

PCF Canvas Apps

File: pcf-canvas-apps.instructions.md
Applies to: **/*.tsx, **/*.ts
PCF components for canvas apps with security and configuration.

Power Apps Canvas YAML

File: power-apps-canvas-yaml.instructions.md
Applies to: **/*.pa.yaml, **/*.fx.yaml
Power Apps Canvas app YAML format patterns.

Power Apps Code Apps

File: power-apps-code-apps.instructions.md
Applies to: **/*.tsx, **/*.ts
Code-first Power Apps development patterns.

Power BI

Power BI DAX

File: power-bi-dax-best-practices.instructions.md
Applies to: **/*.dax
DAX best practices for Power BI calculations.

Power BI Data Modeling

File: power-bi-data-modeling-best-practices.instructions.md
Applies to: **/*.pbit, **/*.pbix
Power BI data modeling best practices.

Power BI Report Design

File: power-bi-report-design-best-practices.instructions.md
Applies to: **/*.pbix
Power BI report design and visualization best practices.

Power BI Security & RLS

File: power-bi-security-rls-best-practices.instructions.md
Applies to: **/*.dax, **/*.pbix
Row-level security and data protection in Power BI.

Power BI Custom Visuals

File: power-bi-custom-visuals-development.instructions.md
Applies to: **/*.ts, **/*.tsx
Custom visual development for Power BI.

Power BI DevOps & ALM

File: power-bi-devops-alm-best-practices.instructions.md
Applies to: **/*.json, **/*.yml
Application lifecycle management for Power BI solutions.

Dataverse

Dataverse Python SDK

File: dataverse-python.instructions.md
Applies to: **/*.py
Dataverse SDK for Python development patterns.

Dataverse Best Practices

File: dataverse-python-best-practices.instructions.md
Applies to: **/*.py
Best practices for Dataverse Python SDK usage.

Dataverse Authentication

File: dataverse-python-authentication-security.instructions.md
Applies to: **/*.py
Authentication and security patterns for Dataverse.

Dataverse Performance

File: dataverse-python-performance-optimization.instructions.md
Applies to: **/*.py
Performance optimization for Dataverse operations.

Power Platform Connectors

Power Platform Connector

File: power-platform-connector.instructions.md
Applies to: **/*.json
Custom connector development for Power Platform.

Salesforce

Apex

File: apex.instructions.md
Applies to: **/*.cls, **/*.trigger
Salesforce Apex development guidelines and best practices.

Lightning Web Components

File: lwc.instructions.md
Applies to: **/*.js, **/*.html, **/*.css
Lightning Web Components development patterns.

MCP Server Development

Model Context Protocol (MCP) server implementation guides for various languages:

TypeScript MCP

File: typescript-mcp-server.instructions.md
Applies to: **/*.ts

Python MCP

File: python-mcp-server.instructions.md
Applies to: **/*.py

C# MCP

File: csharp-mcp-server.instructions.md
Applies to: **/*.cs

Go MCP

File: go-mcp-server.instructions.md
Applies to: **/*.go

Java MCP

File: java-mcp-server.instructions.md
Applies to: **/*.java

Kotlin MCP

File: kotlin-mcp-server.instructions.md
Applies to: **/*.kt

PHP MCP

File: php-mcp-server.instructions.md
Applies to: **/*.php

Ruby MCP

File: ruby-mcp-server.instructions.md
Applies to: **/*.rb

Rust MCP

File: rust-mcp-server.instructions.md
Applies to: **/*.rs

Swift MCP

File: swift-mcp-server.instructions.md
Applies to: **/*.swift

Cross-Cutting Concerns

Security

Security & OWASP

File: security-and-owasp.instructions.md
Applies to: **
OWASP security guidelines and vulnerability prevention.

Agent Safety

File: agent-safety.instructions.md
Applies to: **
Safety and governance for AI agent systems.

Accessibility

Accessibility (a11y)

File: a11y.instructions.md
Applies to: **
WCAG 2.2 Level AA compliance and accessibility best practices.

Markdown Accessibility

File: markdown-accessibility.instructions.md
Applies to: **/*.md, **/*.mdx
Accessible markdown content guidelines.

Performance & Optimization

Performance Optimization

File: performance-optimization.instructions.md
Applies to: **
General performance optimization patterns.

Object Calisthenics

File: object-calisthenics.instructions.md
Applies to: **
Nine rules for better object-oriented code.

Code Quality

Code Review

File: code-review-generic.instructions.md
Applies to: **
Generic code review guidelines and best practices.

Self-Explanatory Code

File: self-explanatory-code-commenting.instructions.md
Applies to: **
Guidelines for writing self-documenting code with minimal comments.

Context Engineering

File: context-engineering.instructions.md
Applies to: **
Structuring code for better GitHub Copilot context.

AI & Prompt Engineering

AI Prompt Engineering

File: ai-prompt-engineering-safety-best-practices.instructions.md
Applies to: **
Comprehensive AI prompt engineering and safety frameworks.

Custom Agent Guidelines

File: agents.instructions.md
Applies to: **/*.agent.md
Guidelines for creating custom GitHub Copilot agent files.

Agent Skills Guidelines

File: agent-skills.instructions.md
Applies to: **/SKILL.md
Creating high-quality Agent Skills for GitHub Copilot.

Custom Instructions Guidelines

File: instructions.instructions.md
Applies to: **/*.instructions.md
Meta-instructions for creating custom instruction files.

Copilot Prompts

File: prompt.instructions.md
Applies to: **/*.prompt.md
Guidelines for creating Copilot prompt files.

Scripting & Shell

Shell Scripts

File: shell.instructions.md
Applies to: **/*.sh, **/*.bash
Shell scripting best practices and patterns.

PowerShell

File: powershell.instructions.md
Applies to: **/*.ps1, **/*.psm1
PowerShell scripting conventions and best practices.

Makefile

File: makefile.instructions.md
Applies to: **/Makefile, **/*.mk
Makefile structure and build automation patterns.

Content & Documentation

Markdown

File: markdown.instructions.md
Applies to: **/*.md, **/*.mdx
Markdown formatting and structure guidelines.

Localization

File: localization.instructions.md
Applies to: **/*.json, **/*.yml
Internationalization and localization best practices.

WordPress

File: wordpress.instructions.md
Applies to: **/*.php
WordPress theme and plugin development.

Moodle

File: moodle.instructions.md
Applies to: **/*.php
Moodle plugin and module development.

Linux Administration

Arch Linux

File: arch-linux.instructions.md
Applies to: **/*.sh
Arch Linux administration and pacman workflows.

Debian Linux

File: debian-linux.instructions.md
Applies to: **/*.sh
Debian administration and apt package management.

Fedora Linux

File: fedora-linux.instructions.md
Applies to: **/*.sh
Fedora administration and dnf package management.

CentOS Linux

File: centos-linux.instructions.md
Applies to: **/*.sh
CentOS administration and RHEL-compatible tooling.

Specialized Tools & Frameworks

GenAIScript

File: genaiscript.instructions.md
Applies to: **/*.genai.mjs, **/*.genai.js
GenAIScript patterns for AI automation.

Tailwind v4

File: tailwind-v4-vite.instructions.md
Applies to: **/*.css, **/*.html
Tailwind CSS v4 with Vite configuration.

HTML/CSS Style Guide

File: html-css-style-color-guide.instructions.md
Applies to: **/*.html, **/*.css
HTML and CSS styling and color usage guidelines.

CMake & vcpkg

File: cmake-vcpkg.instructions.md
Applies to: **/CMakeLists.txt, **/*.cmake
C++ project configuration and package management.

ColdFusion CFC

File: coldfusion-cfc.instructions.md
Applies to: **/*.cfc
ColdFusion component patterns.

ColdFusion CFM

File: coldfusion-cfm.instructions.md
Applies to: **/*.cfm
ColdFusion page and application patterns.

Migration & Upgrade Guides

  • dotnet-upgrade.instructions.md - Comprehensive .NET framework upgrades
  • dotnet-maui-9-to-dotnet-maui-10-upgrade.instructions.md - MAUI 9 to 10 migration
  • java-11-to-java-17-upgrade.instructions.md - Java 11 to 17 migration
  • java-17-to-java-21-upgrade.instructions.md - Java 17 to 21 migration
  • java-21-to-java-25-upgrade.instructions.md - Java 21 to 25 migration
  • springboot-4-migration.instructions.md - Spring Boot 4 migration guide
  • convert-jpa-to-spring-data-cosmos.instructions.md - JPA to Spring Data Cosmos
  • convert-cassandra-to-spring-data-cosmos.instructions.md - Cassandra to Spring Data Cosmos

Utility & Development Tools

DevBox Image Definition

File: devbox-image-definition.instructions.md
Applies to: **/*.yaml, **/*.yml
DevBox development environment configuration.

Context7

File: context7.instructions.md
Applies to: **
Using Context7 for authoritative external documentation.

Copilot Thought Logging

File: copilot-thought-logging.instructions.md
Applies to: **
Track and document Copilot’s decision-making process.

Memory Bank

File: memory-bank.instructions.md
Applies to: **
Persistent memory patterns for AI interactions.

Task Implementation

File: task-implementation.instructions.md
Applies to: **
Structured task implementation patterns.

Spec-Driven Workflow

File: spec-driven-workflow-v1.instructions.md
Applies to: **
Specification-driven development workflow.

Browse All Instructions

To view the complete source code for any instruction file, visit the Awesome GitHub Copilot repository on GitHub.

Installation

Each instruction can be installed directly into VS Code or VS Code Insiders using the install buttons in the main repository README. Alternatively, download the .instructions.md file and add it to your project’s .github/instructions/ directory.

Contributing

Have a custom instruction to share? Contributions are welcome! See the Contributing Guide for details on adding new instructions to the catalog.

Build docs developers (and LLMs) love