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

https://github.com/lukepadiachy/copilot-instructions-experiment

This repo is a hands-on experiment in customizing GitHub Copilot using repository-level instructions, prompt files, and chat modes. Each branch demonstrates a specific Copilot customization, instruction, or architectural pattern, allowing users to explore how Copilot adapts to different coding workflows and requirements.
https://github.com/lukepadiachy/copilot-instructions-experiment

agent-mode blazor blazor-server-app copilot-instructions dotnet github-copilot pokeapinet

Last synced: 5 months ago
JSON representation

This repo is a hands-on experiment in customizing GitHub Copilot using repository-level instructions, prompt files, and chat modes. Each branch demonstrates a specific Copilot customization, instruction, or architectural pattern, allowing users to explore how Copilot adapts to different coding workflows and requirements.

Awesome Lists containing this project

README

          

# Copilot Instructions Experiment

![Copilot Instructions](https://i.imgur.com/FzR7MHT.png)

## Overview

This repository is a living experiment in customizing GitHub Copilot using repository-level instructions, prompt files and chat modes. Each branch in this repo demonstrates a specific Copilot customization or instruction, with a clear purpose and practical example. The goal is not to follow a strict tutorial, but to let you explore the capabilities and benefits of Copilot customization by switching between branches and seeing the impact of each change in context.

The **main** branch is a clean starting point, providing only this overview and a breakdown of the Copilot instruction concepts. All other branches add a specific instruction, prompt or architectural pattern, so you can see how Copilot adapts and assists as the project evolves.

## How to Use This Repo

1. **Start on `main`** to get the context and understand the motivation for customizing Copilot.
2. **Fork this repository** to your own GitHub account by clicking the "Fork on GitHub" button below or at the bottom of this README:
[![Fork on GitHub](https://img.shields.io/badge/Fork%20this%20repo-Fork%20on%20GitHub-green?style=for-the-badge&logo=github)](https://github.com/lukepadiachy/copilot-instructions-experiment/fork)
3. **Switch to any `part-*` branch** to see a focused experiment or instruction in action:
- Each branch adds or refines a Copilot instruction, prompt file, or code pattern.
- Review the Copilot instructions, prompt files, and code changes in that branch.
- Try using Copilot Chat with the provided prompts and instructions to see how Copilot's suggestions and behavior change.
- There is no required order—jump to any branch that interests you and see the effect of that customization.

## Branch Guide & Purpose

- **main**: The starting point. Contains only this overview and a breakdown of Copilot instruction concepts.
- **part-one/add-copilot-instructions**: Adds a `.github/copilot-instructions.md` file to set workspace-wide Copilot behavior and preferences.
- **part-two/add-copilot-prompts**: Introduces reusable prompt files (e.g., for code review, security checks) that can be invoked in Copilot Chat.
- **part-three/add-pokemon-blazor-project**: Adds a .NET Blazor project as a practical playground for Copilot customization.
- **part-four/add-task-specific-instruction**: Refines Copilot instructions to be more task-specific, guiding Copilot for particular coding tasks or workflows.
- **part-five/add-pokemons-page**: Implements a new Pokémons page in the Blazor app, using Copilot prompts and instructions to build a visually appealing gallery with PokeApiNet.
- **part-six/add-service-refactor-instruction**: Focuses on best practices for Blazor data services, refactoring prompts and instructions to encourage clean architecture and separation of concerns.
- **part-seven/add-service-refactor**: Implements the refactored services and updates Blazor components to use them, demonstrating Copilot's ability to assist with larger-scale refactoring guided by custom instructions.

## Customize Copilot....

![Reasons for copilot](https://i.imgur.com/n7CIku4.png)

Customizing Copilot at the repo level lets you:
- Set consistent coding style and workflow for your team or project.
- Create repeatable, task-specific Copilot chat commands with prompt files.
- Guide Copilot for real-world .NET/Blazor development, including UI, data fetching, and refactoring.
- See how Copilot responds to increasingly specific and complex instructions as your project grows.

## Learn More About Copilot Customization

GitHub Copilot can be tailored to your workflow and project needs. For a detailed overview of customization options, see:

- [Customize Copilot in VS Code – Official Docs](https://code.visualstudio.com/docs/copilot/copilot-customization)

This guide explains how to add repository-level instructions, create prompt files, and use chat modes to get the most out of Copilot in your development process.

Other resources:
- [GitHub Docs – Adding Repo Instructions](https://docs.github.com/en/copilot/how-tos/custom-instructions/adding-repository-custom-instructions-for-github-copilot)
- [MCP Servers for agent mode](https://code.visualstudio.com/mcp)
- [Sample Chat Mode File by Burke Holland](https://gist.github.com/burkeholland/a232b706994aa2f4b2ddd3d97b11f9a7)
- [PokeApiNet - A .Net wrapper for the Pokemon API](https://gist.github.com/burkeholland/a232b706994aa2f4b2ddd3d97b11f9a7)

**Each branch is a snapshot of Copilot customization at a different stage, with practical examples and lessons learned. Switch between branches to explore and experiment!**

[![LinkedIn](https://img.shields.io/badge/Share-LinkedIn-blue?style=for-the-badge&logo=linkedin)](https://www.linkedin.com/shareArticle?title=Copilot%20Instructions%20Experiment&url=https://github.com/lukepadiachy/copilot-instructions-experiment)
[![X](https://img.shields.io/badge/Share-X-1DA1F2?style=for-the-badge&logo=twitter)](https://twitter.com/intent/tweet?text=Check%20out%20this%20Copilot%20Instructions%20Experiment!%20https://github.com/lukepadiachy/copilot-instructions-experiment)
[![Facebook](https://img.shields.io/badge/Share-Facebook-1877F2?style=for-the-badge&logo=facebook)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/lukepadiachy/copilot-instructions-experiment)
[![WhatsApp](https://img.shields.io/badge/Share-WhatsApp-25D366?style=for-the-badge&logo=whatsapp)](https://api.whatsapp.com/send?text=Check%20out%20this%20Copilot%20Instructions%20Experiment!%20https://github.com/lukepadiachy/copilot-instructions-experiment)