Skip to main content

GitHub Copilot - Custom Instructions

I talked about custom instructions before as a way to tweak the Copilot prompt when interacting with GitHub Copilot. At that time it was rather limited and you had not much control on how it was applied.

The way it was handled was through a custom Markdown copilot-instructions.md file. This feature has further evolved and now you can specify instructions for multiple purposes:

  • Code-generation instructions - provide context specific for generating code. You can specify those instructions directly in the settings, or in a Markdown file in your workspace.

  • Test-generation instructions - provide context specific for generating tests.  You can specify those instructions directly in the settings, or in a Markdown file your workspace.

  • Code review instructions - provide context specific for reviewing the current editor selection. You can specify those instructions directly in the settings, or in a Markdown file in your workspace.

  • Commit message generation instructions - provide context specific for generating commit messages. You can specify those instructions directly in the settings, or in a Markdown file in your workspace.

Configure a specific set of instructions

  • Open the Command Palette: Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (macOS) to open the Command Palette.

  • Open Settings (JSON): Type Preferences: Open Settings (JSON) and select it from the list.

  • Edit the settings.jsonfile: This will open the settings.json file where you can add or modify settings.Now we can add for example a code-generation instruction:

  • Save the file: After making your changes, save the settings.json file.

Here are the different settings that can be used:

Instruction Setting
Code-generation instructions

github.copilot.chat.codeGeneration.instructions
Test-generation instructions

github.copilot.chat.testGeneration.instructions
Code review instructions

github.copilot.chat.reviewSelection.instructions
Commit message instructions

github.copilot.chat.commitMessageGeneration.instructions

    Remark: If you define custom instructions in both the .github/copilot-instructions.md file and in settings, Copilot tries to combine instructions from both sources.

    More information

    Custom instructions when using GitHub Copilot

    Custom instructions for GitHub Copilot in VS Code

    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