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

Kubernetes–Limit your environmental impact

Reducing the carbon footprint and CO2 emission of our (cloud) workloads, is a responsibility of all of us. If you are running a Kubernetes cluster, have a look at Kube-Green . kube-green is a simple Kubernetes operator that automatically shuts down (some of) your pods when you don't need them. A single pod produces about 11 Kg CO2eq per year( here the calculation). Reason enough to give it a try! Installing kube-green in your cluster The easiest way to install the operator in your cluster is through kubectl. We first need to install a cert-manager: kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.5/cert-manager.yaml Remark: Wait a minute before you continue as it can take some time before the cert-manager is up & running inside your cluster. Now we can install the kube-green operator: kubectl apply -f https://github.com/kube-green/kube-green/releases/latest/download/kube-green.yaml Now in the namespace where we want t...
Read more

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

DevToys–A swiss army knife for developers

As a developer there are a lot of small tasks you need to do as part of your coding, debugging and testing activities.  DevToys is an offline windows app that tries to help you with these tasks. Instead of using different websites you get a fully offline experience offering help for a large list of tasks. Many tools are available. Here is the current list: Converters JSON <> YAML Timestamp Number Base Cron Parser Encoders / Decoders HTML URL Base64 Text & Image GZip JWT Decoder Formatters JSON SQL XML Generators Hash (MD5, SHA1, SHA256, SHA512) UUID 1 and 4 Lorem Ipsum Checksum Text Escape / Unescape Inspector & Case Converter Regex Tester Text Comparer XML Validator Markdown Preview Graphic Col...
Read more
OSZAR »