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

    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

    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

    VS Code Planning mode

    After the introduction of Plan mode in Visual Studio , it now also found its way into VS Code. Planning mode, or as I like to call it 'Hannibal mode', extends GitHub Copilot's Agent Mode capabilities to handle larger, multi-step coding tasks with a structured approach. Instead of jumping straight into code generation, Planning mode creates a detailed execution plan. If you want more details, have a look at my previous post . Putting plan mode into action VS Code takes a different approach compared to Visual Studio when using plan mode. Instead of a configuration setting that you can activate but have limited control over, planning is available as a separate chat mode/agent: I like this approach better than how Visual Studio does it as you have explicit control when plan mode is activated. Instead of immediately diving into execution, the plan agent creates a plan and asks some follow up questions: You can further edit the plan by clicking on ‘Open in Editor’: ...
    Read more