Tips and tricks for Copilot in VS Code

This article provides tips and tricks to optimize your development experience for using GitHub Copilot in Visual Studio Code.

Checklist for using Copilot in VS Code

Use the following checklist to get the most out of Copilot:

1. Choose the right tool. Use the tool that's optimized for editing, asking questions, or staying in the flow of writing code.

2. Personalize Copilot. Use custom instructions to get code suggestions that match your style and coding practices.

3. Write effective prompts and provide context. Get the most relevant responses.

4. Index your workspace. Receive accurate responses to questions about your codebase.

5. Choose your AI model. Choose between models for fast coding or planning/reasoning.

6. Reuse prompts. Save time by saving and reusing task-specific prompts across your team.

Choose the right Copilot tool

Depending on your task, you can choose between different Copilot tools.

Personalize Copilot with custom instructions

When Copilot generates code or answers questions, it tries to match your coding practices and preferences such as which libraries you use or how you name your variables. However, it might not always have enough context to do this effectively. For example, if you work with a specific framework version, you need to provide additional context in your prompts.

To enhance Copilot's responses, you can use custom instructions to provide it with contextual details about your team's workflow, tools, or project specifics. Copilot then incorporates these custom instructions with every request.

To enable custom instructions for your workspace:

1. Create a .github/copilot-instructions.md file in the root of your workspace

2. Add your instructions in Markdown format to the file. For example:

   # Custom instructions for Copilot
   
   ## Project context
   This project is a web application built with React and Node.js.
   
   ## Indentation
   We use tabs, not spaces.
   
   ## Coding style
   Use camelCase for variable names and prefer arrow functions over traditional function expressions.
   
   ## Testing
   We use Jest for unit testing and Playwright for end-to-end testing.
   Copy

Get more details about using custom instructions for Copilot in VS Code.

Prompt engineering

You can enhance the quality of Copilot's responses by using effective prompts. A well-crafted prompt can help Copilot understand your requirements better and generate more relevant code suggestions.

• Start general, then get specific.

  Generate a Calculator class.
  Add methods for addition, subtraction, multiplication, division, and factorial.
  Don't use any external libraries and don't use recursion.
  Copy

• Give examples of what you want.

  Generate a function that takes a string and returns the number of vowels in it.
  Example:
  findVowels("hello") returns 2
  findVowels("sky") returns 0
  Copy

• Break down complex tasks into simpler tasks.

  Instead of asking Copilot to generate a meal planner app, break it down into smaller tasks:

  • Generate a function that takes a list of ingredients and returns a list of recipes.
  • Generate a function that takes a list of recipes and returns a shopping list.
  • Generate a function that takes a list of recipes and returns a meal plan for the week.

• Provide the right context, such as code selections, files, terminal output, and more.

  Example, use the #codebase variable to refer to the entire codebase:

  Where is the database connection string used in #codebase?
  Copy

• Iterate on your prompts.

  Provide follow-up prompts to refine or modify the response. For example:

  • "Write a function to calculate the factorial of a number."
  • "Don't use recursion and optimize by using caching."
  • "Use meaningful variable names."

• Keep chat history relevant.

  Copilot uses history of the conversation to provide context. Remove past questions and responses from the history if they're not relevant. Or, start a new session if you want to change the context.

Get more details about prompt engineering.

Find practical examples of prompts to use with Copilot in the GitHub Copilot documentation.

Provide the right context

Enrich your prompts with relevant context to get more accurate and relevant response from Copilot.

• Use the #codebase variable to let Copilot find the right files automatically.
• Reference files or symbols in your prompt by using #file or #sym chat variables.
• Drag and drop files, folders, or editor tabs onto the chat prompt.
• Add problems, test failures, or terminal output to your chat prompt for scenario-specific context.
• Add images or screenshots to your prompt to let Copilot analyze the image.

When you use agent mode, Copilot autonomously finds the relevant files and context for you.

Get more details about adding context to chat prompts.

Reusable prompts

Reusable prompts enable you to save a prompt for a specific task with its context and instructions in a file. You can then attach and reuse that prompt in chat. If you store the prompt in your workspace, you can also share it with your team.

To create a reusable prompt:

1. Create a prompt file with the Create Prompt command from the Command Palette.

   This command creates a .prompt.md file in the .github/prompts folder at the root of your workspace.

2. Describe your prompt and relevant context in Markdown format.

   For example, use this prompt to generate a new React form component.

   Your goal is to generate a new React form component.
   
   Ask for the form name and fields if not provided.
   
   Requirements for the form:
   * Use form design system components: [design-system/Form.md](../docs/design-system/Form.md)
   * Use `react-hook-form` for form state management:
   * Always define TypeScript types for your form data
   * Prefer *uncontrolled* components using register
   * Use `defaultValues` to prevent unnecessary rerenders
   * Use `yup` for validation:
   * Create reusable validation schemas in separate files
   * Use TypeScript types to ensure type safety
   * Customize UX-friendly validation rules
   Copy

3. Add the prompt as context in chat.

Get started with reusable prompts.

Choose your AI model

Copilot offers different AI models to choose from. Some models are optimized for fast coding tasks, while others are better suited for slower planning and reasoning tasks.

Choose the model that best fits your needs by using the model picker in the chat input field.

Learn more about AI models for Copilot Chat in the GitHub Copilot documentation.

Workspace indexing

Copilot uses an index to quickly and accurately search your codebase for relevant code snippets. This index can either be maintained by GitHub or stored locally on your machine.

For GitHub repositories, you can use a remote index of your workspace, based on GitHub code search. This allows Copilot to search your entire codebase very quickly, even if the codebase is very large.

Get more details about workspace indexing.

Related resources

• Prompt engineering for Copilot Chat
• Best Practices for using GitHub Copilot in the GitHub Copilot documentation
• Personalize Copilot in VS Code