Your first prompt file

Create your first Copilot prompt file with this simple code explanation example that works for any programming language.

Neste artigo

Observação

About customizations

You can customize GitHub Copilot's responses using two types of files:

  • Custom instructions provide ongoing guidance for how GitHub Copilot should behave across all your interactions. For an introductory example, see Your first custom instructions.
  • Prompt files (public preview) define reusable prompts for specific tasks that you can invoke when needed. Prompt files are only available in VS Code.

Your first prompt file

Start with this simple prompt file that helps you write clear, well-documented code explanations.

Code explanation prompt

Text
---
mode: 'agent'
description: 'Generate a clear code explanation with examples'
---

Explain the following code in a clear, beginner-friendly way:

Code to explain: ${input:code:Paste your code here}
Target audience: ${input:audience:Who is this explanation for? (e.g., beginners, intermediate developers, etc.)}

Please provide:

* A brief overview of what the code does
* A step-by-step breakdown of the main parts
* Explanation of any key concepts or terminology
* A simple example showing how it works
* Common use cases or when you might use this approach

Use clear, simple language and avoid unnecessary jargon.

Test it out

  1. Save the prompt file above as explain-code.prompt.md in your .github/prompts folder.

  2. In Visual Studio Code, display the Copilot Chat view and enter /explain-code.

    Copilot will switch to agent mode, if this is not already selected, and will prompt you to enter some code and an audience type.

  3. Enter:

    Text
    The code is `function fibonacci(n) { return n <= 1 ? n : fibonacci(n-1) + fibonacci(n-2); }`. The audience is beginners.

Further reading