Skip to main content

Finding inspiration for good custom instructions for GitHub Copilot

One of the best ways to improve the results you get back from GitHub Copilot is by carefully defining your custom instructions. This helps the LLM to better understand your application, preferred technologies, coding guidelines, etc.. This information is shared with the LLM for every request, so you don’t have to provide all these details every time in your prompts.

But creating such a set of custom instructions can be a challenge. If you are looking for inspiration, here are some possible sources:

Awesome Copilot Instructions

Link: Code-and-Sorts/awesome-copilot-instructions: ✨ Curated list of awesome GitHub copilot-instructions.md files

Description: Contains a list of copilot instructions for different programming languages

Cursor Rules

Link: Free AI .cursorrules & .mdc Config Generator | Open Source Developer Tools

Description: Originally created for the Cursor IDE but also applicable when defining custom instructions for GitHub Copilot. No examples for .NET or CSharp but web frameworks are well represented.

Cursor Directory

Link: Cursor Directory

Description: Originally created for the Cursor IDE but also applicable when defining custom instructions for GitHub Copilot. The list of available examples is large. Especially web frameworks and technologies are well represented here.

A last tip

A last tip I found on the blog of Burke Holland is to add an extra instruction to avoid hallucinations and let the LLM ask you when it needs more context.

Avoid making assumptions. If you need additional context to accurately answer the user, ask the user for the missing information. Be specific about which context you need.

More information

Custom instructions when using GitHub Copilot

Adding repository custom instructions for GitHub Copilot - GitHub Docs

Free AI .cursorrules & .mdc Config Generator | Open Source Developer Tools

Cursor Directory

Essential custom instructions for GitHub Copilot · Burke Holland

Labels:

Popular posts from this blog

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.
Read more

Podman– Command execution failed with exit code 125

After updating WSL on one of the developer machines, Podman failed to work. When we took a look through Podman Desktop, we noticed that Podman had stopped running and returned the following error message: Error: Command execution failed with exit code 125 Here are the steps we tried to fix the issue: We started by running podman info to get some extra details on what could be wrong: >podman info OS: windows/amd64 provider: wsl version: 5.3.1 Cannot connect to Podman. Please verify your connection to the Linux system using `podman system connection list`, or try `podman machine init` and `podman machine start` to manage a new Linux VM Error: unable to connect to Podman socket: failed to connect: dial tcp 127.0.0.1:2655: connectex: No connection could be made because the target machine actively refused it. That makes sense as the podman VM was not running. Let’s check the VM: >podman machine list NAME         ...
Read more

Cleaner switch expressions with pattern matching in C#

Ever find yourself mapping multiple string values to the same result? Being a C# developer for a long time, I sometimes forget that the C# has evolved so I still dare to chain case labels or reach for a dictionary. Of course with pattern matching this is no longer necessary. With pattern matching, you can express things inline, declaratively, and with zero repetition. A small example I was working on a small script that should invoke different actions depending on the environment. As our developers were using different variations for the same environment e.g.  "tst" alongside "test" , "prd" alongside "prod" .  We asked to streamline this a long time ago, but as these things happen, we still see variations in the wild. This brought me to the following code that is a perfect example for pattern matching: The or keyword here is a logical pattern combinator , not a boolean operator. It matches if either of the specified pattern...
Read more