Cómo agregar instrucciones personalizadas para GitHub Copilot

Acerca de las instrucciones personalizadas para GitHub Copilot

GitHub Copilot puede proporcionar respuestas de chat adaptadas a la forma en que trabaja tu equipo, las herramientas que usas o los detalles específicos del proyecto, si le proporcionas suficiente contexto para ello. En lugar de agregar este detalle contextual en repetidas ocasiones a tus preguntas de chat, puedes crear un archivo que agregue esta información de forma automática. La información adicional no se muestra en el chat, pero está disponible para Copilot con el fin de que pueda generar respuestas de mayor calidad.

Requisitos previos

• Un archivo de instrucciones personalizado (consulta las instrucciones a continuación).

• La opción Use Instruction Files (VS Code) o Enable custom instructions (Visual Studio) habilitada en la configuración. Consulta Cómo habilitar o deshabilitar instrucciones personalizadas más adelante en este artículo.

  Note

  De forma predeterminada, la configuración está habilitada en VS Code y deshabilitada en Visual Studio.

Creación de un archivo de instrucciones personalizadas

1. En la raíz del repositorio, crea un archivo con el nombre .github/copilot-instructions.md.

   Crea el directorio .github si no existe todavía.

2. Agrega instrucciones de lenguaje natural al archivo en formato Markdown.

   Se ignora el espacio en blanco entre las instrucciones, por lo que estas pueden escribirse como un solo párrafo, cada una en una nueva línea o separadas por líneas en blanco para mejorar la legibilidad.

Instrucciones de muestra

Este ejemplo de un archivo .github/copilot-instructions.md contiene tres instrucciones que se agregarán a todas las preguntas de chat.

We use Bazel for managing our Java dependencies, not Maven, so when talking about Java packages, always give me instructions and code samples that use Bazel.

We always write JavaScript with double quotes and tabs for indentation, so when your responses include JavaScript code, please follow those conventions.

Our team uses Jira for tracking items of work.

Redacción de instrucciones personalizadas eficientes

Las instrucciones que agregues al archivo .github/copilot-instructions.md deben ser breves, autosuficientes y agregar contexto o información pertinente para complementar las preguntas de chat de los usuarios.

Es poco probable que los siguientes tipos de instrucciones funcionen como se desea y pueden causar problemas con otras áreas de Copilot:

• Solicitudes para hacer referencia a recursos externos al formular una respuesta
• Instrucciones para responder con un estilo determinado
• Solicitudes para responder siempre con cierto nivel de detalle

Por lo tanto, es poco probable que las instrucciones siguientes tengan el resultado previsto:

Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code.

Use @terminal when answering questions about Git.

Answer all questions in the style of a friendly colleague, using informal language.

Answer all questions in less than 1000 characters, and words of no more than 12 characters.

Instrucciones personalizadas en uso

Las instrucciones del archivo .github/copilot-instructions.md están disponibles para que Copilot Chat las use tan pronto como guardes el archivo. El conjunto completo de instrucciones se asociará automáticamente a las solicitudes que envíes en la vista de Copilot Chat o en el chat en línea, en VS Code y en Visual Studio.

Las instrucciones personalizadas no aparecen en la vista de chat ni en el chat en línea, pero puedes comprobar que Copilot las está usando si examinas la lista de referencias de una respuesta. Si se han agregado instrucciones personalizadas a la solicitud que se ha enviado al modelo, el archivo .github/copilot-instructions.md aparece como referencia. Puedes hacer clic en la referencia para abrir el archivo.

Cómo habilitar o deshabilitar instrucciones personalizadas

Puedes elegir si quieres que se agreguen instrucciones personalizadas a tus preguntas de chat o no. Para ello, activa o desactiva la opción en la configuración de la extensión de Copilot.

En VS Code

1. Abre el editor de configuración mediante el método abreviado de teclado Command+, (Mac)/Ctrl+, (Linux/Windows).
2. Escriba instruction file en el cuadro de búsqueda.
3. Activa o desactiva la casilla en Code Generation: Use Instruction Files.

En Visual Studio

1. En la barra de menús de Visual Studio, en Herramientas, haz clic en Opciones.

   

2. En el cuadro de diálogo "Options", escribe custom instructions en el cuadro de búsqueda.

3. Activa o desactiva la casilla para (Preview) Enable custom instructions to be loaded from .github/copilot-instructions.md files and added to requests.