Instrucciones personalizadas para GitHub Copilot

Acerca de la personalización de las Copilot respuestas

GitHub Copilot puede proporcionar respuestas adaptadas a sus preferencias, la forma en que trabaja su equipo, las herramientas que usa y las particularidades de su proyecto. En lugar de agregar repetidamente el mismo contexto a las solicitudes, puede crear instrucciones personalizadas que proporcionen automáticamente esta información a Copilot para que genere respuestas de mayor calidad.

Los archivos de prompt proporcionan otra manera de proporcionar Copilot instrucciones y contexto específicos de la tarea. A diferencia de las instrucciones personalizadas, eliges cuándo usarlas en un chat. Para obtener más información, vea Archivos de prompts para GitHub Copilot.

Los tipos de instrucciones personalizadas disponibles y las Copilot características que las usan varían según el cliente y la superficie (GitHub.com, Visual Studio Code, Visual Studio, JetBrains IDEs, Xcode y Eclipse). Para comprobar qué tipos admite su entorno, consulte Compatibilidad con diferentes tipos de instrucciones personalizadas. Para ver los IDE y las versiones compatibles, consulte matriz de características de Copilot.

Nota:

Debido a la naturaleza no determinista de la inteligencia artificial, Copilot puede que no siempre siga las instrucciones personalizadas de la misma manera cada vez que se usan.

Tipos de instrucciones personalizadas

Las instrucciones personalizadas se pueden aplicar en distintos niveles:

Tipo	Ámbito	Ejemplo de usos
Instrucciones personales	Sus conversaciones con Copilot	Especifique sus preferencias individuales, como el idioma preferido o el estilo de respuesta.
Instrucciones personalizadas del repositorio	Conversaciones con Copilot realizadas en el contexto de un repositorio, un proyecto, una ruta de acceso o un agente compatible	Describir los lenguajes, marcos, herramientas, arquitectura y convenciones de codificación que se usan en un proyecto.
Instrucciones personalizadas de la organización	Conversaciones con Copilot cuando se usan en el contexto de una organización	Proporcione instrucciones de lenguaje, seguridad, cumplimiento o respuesta para toda la organización.

Algunos clientes (JetBrains IDEs y Xcode) proporcionan mecanismos de instrucción globales, de espacio de trabajo o de proyecto adicionales. Estos mecanismos no siempre se asignan directamente a instrucciones personales, de repositorio y de organización en GitHub.

Acerca de las instrucciones personales

Instrucciones personales configuradas en GitHub.com se aplican a GitHub Copilot Chat in GitHub. Otros clientes, como Copilot CLI, usan archivos locales como instrucciones personales. Consulte Adición de instrucciones personalizadas para GitHub Copilot CLI.

Puede personalizar cómo Copilot Chat responde a usted en GitHub.com agregando instrucciones personales. Estas instrucciones solo se aplican a usted. Por ejemplo, puede especificar su idioma preferido, el nivel de detalle que desee o cómo desea que se estructuren las respuestas. Consulte Adición de instrucciones personalizadas personales para GitHub Copilot.

Acerca de las instrucciones personalizadas del repositorio

Las instrucciones personalizadas del repositorio proporcionan orientación y contexto específicos del proyecto. Por ejemplo, puede describir el propósito del repositorio, los marcos y las herramientas que usa, y las convenciones de codificación o pruebas que deben seguir los colaboradores.

Hay tres tipos principales de instrucciones personalizadas del repositorio:

Instrucciones personalizadas para todo el repositorio, que se aplican a todas las solicitudes realizadas en el contexto de un repositorio.

Se especifican en un archivo copilot-instructions.md en el directorio .github del repositorio.
Instrucciones personalizadas específicas de la ruta de acceso, que se aplican a las solicitudes realizadas en el contexto de los archivos que coinciden con una ruta de acceso especificada.

Se especifican en uno o varios NAME.instructions.md archivos dentro o debajo del .github/instructions directorio del repositorio.

Al usar instrucciones específicas de la ruta de acceso, puedes evitar sobrecargar las instrucciones de todo el repositorio con información que solo se aplica a archivos de determinados tipos o en determinados directorios.
Instrucciones del agente, que son similares a las instrucciones personalizadas de todo el repositorio, pero que actualmente no son compatibles con todas las características de Copilot.

Se especifican en archivos denominados AGENTS.md, CLAUDE.mdo GEMINI.md.

Para obtener detalles sobre la compatibilidad de cada uno de estos tipos de e instrucciones personalizadas del repositorio a través de diferentes características de Copilot, consulte Compatibilidad con diferentes tipos de instrucciones personalizadas.

Para obtener una colección seleccionada de ejemplos, consulte Instrucciones personalizadas.

Tenga en cuenta que los archivos de instrucciones del agente, como AGENTS.md, proporcionan instrucciones para los agentes de IA admitidos. Son diferentes de los archivos de definición de agente personalizados almacenados en .github/agents, que definen agentes especializados y su configuración. Para ver los nombres de archivo de instrucciones del agente que Copilot reconoce, consulte Compatibilidad con diferentes tipos de instrucciones personalizadas.

Instrucciones personalizadas del repositorio entre clientes e interfaces

Los tipos de instrucciones personalizadas del repositorio que puede usar (instrucciones para todo el repositorio, específicas de la ruta de acceso o del agente) dependen de su entorno y de la tarea, como chatear, trabajar en la nube o revisar una solicitud de incorporación de cambios. Por ejemplo, un entorno puede admitir instrucciones específicas de la ruta de acceso para una tarea, pero no para otra. Para comprobar la compatibilidad con la configuración, consulte Compatibilidad con diferentes tipos de instrucciones personalizadas. Para ver los IDE y las versiones compatibles, consulte matriz de características de Copilot.

Acerca de las instrucciones personalizadas de la organización

Nota:

Soporte técnico: Actualmente, las instrucciones personalizadas de la organización se admiten para las sesiones que se ejecutan en el sitio web de GitHub (en espacios aislados en la nube o en GitHub Actions) y para Copilot code review. No se admiten en sesiones de cliente locales.

Los propietarios de la organización pueden agregar instrucciones para adaptar Copilot a las necesidades y preferencias de su organización. Estas instrucciones se usan para todos los miembros de la organización, independientemente de si reciben su suscripción Copilot de esa organización.

Las instrucciones personalizadas de la organización solo se pueden configurar para organizaciones con una suscripción Copilot Business o Copilot Enterprise.

Por ejemplo, las instrucciones de la organización pueden:

Especifique un idioma que se debe usar en las respuestas.
Proporcione orientación de cumplimiento o seguridad de toda la organización.
Especifique formatos de respuesta preferidos, como no generar bloques de código.
Dirigir a las personas a una base de conocimiento interna o a un canal de soporte técnico para temas concretos.

Para obtener información sobre cómo agregar instrucciones de la organización, consulte Adición de instrucciones personalizadas de la organización para GitHub Copilot.

Prioridad de las instrucciones personalizadas

La precedencia depende del cliente y la característica. La mayoría de las superficies y clientes, incluidos Copilot CLI, Visual Studio Code y Visual Studio, combinan archivos de instrucción aplicables sin definir un orden de precedencia general.

Para Copilot Chat en GitHub.com, se proporcionan todas las instrucciones pertinentes a Copilot. El orden de prioridad, de mayor a menor, es:

Instrucciones personales
Instrucciones personalizadas del repositorio:
1. Instrucciones específicas de la ruta en cualquier archivo aplicable .github/instructions/**/*.instructions.md
2. Instrucciones para todo el repositorio en .github/copilot-instructions.md
3. Instrucciones del agente, como instrucciones en un AGENTS.md archivo
Instrucciones personalizadas de la organización

Siempre que sea posible, intente evitar proporcionar conjuntos conflictivos de instrucciones. Si le preocupa la calidad de la respuesta, puede deshabilitar temporalmente las instrucciones del repositorio. Consulta Agregar instrucciones personalizadas del repositorio para GitHub Copilot.

Usar instrucciones personalizadas

Las instrucciones personalizadas constan de instrucciones de lenguaje natural y son más eficaces cuando son breves e independientes. Tenga en cuenta el ámbito en el que desea que se aplique una instrucción antes de decidir si desea agregarla en el nivel personal, repositorio o organización.

Entre los casos de uso comunes se incluyen:

Preferencias de respuesta. Especifique un idioma preferido, una estructura de respuesta, un tono o un nivel de explicación.
Contexto del proyecto. Explicar el propósito, la arquitectura o el dominio de un repositorio.
Lenguajes y marcos de trabajo. Identifique los lenguajes, bibliotecas, frameworks y versiones que usa un proyecto.
Convenciones de codificación y pruebas. Describir los estándares de nomenclatura, formato, pruebas, control de errores o documentación.
Revisión y guía de seguridad. Identifique los problemas que deben recibir especial atención cuando una función compatible revisa o modifica código.
Requisitos de la organización. Proporcione instrucciones de soporte técnico, seguridad, cumplimiento o idioma de toda la organización.

Por ejemplo:

Instrucción personal: Always respond in Portuguese.
Instrucción personal: Explain a single concept per line. Be clear and concise.
Instrucción del repositorio: Use Vue with the PrimeVue library.
Instrucción del repositorio: Use early returns whenever possible.
Instrucción de la organización: For questions related to security, use the Security Docs Knowledge Base.
Instrucción de la organización: Do not generate code blocks in responses.

Las instrucciones sobre las pruebas, los mensajes de confirmación o la revisión de código pueden proporcionar contexto útil. Sin embargo, las Copilot características que usan una instrucción determinada varían según el cliente y la superficie de interacción, y las instrucciones personalizadas no garantizan que el contenido generado cumpla con una directiva.

Nota:

Al revisar una solicitud de incorporación de cambios, Copilot lee las instrucciones personalizadas del repositorio, las instrucciones del agente y las capacidades del agente de la rama de origen (la rama con sus cambios), y no de la rama base. Por ejemplo, al combinar my-feature-branch en main, Copilot usa las instrucciones y aptitudes de my-feature-branch, por lo que puede probar los cambios en ellas en la misma solicitud de incorporación de cambios sin combinarlas primero.

Redacción de instrucciones personalizadas eficientes

Las instrucciones que añada a sus archivos de instrucciones personalizadas deben ser enunciados breves y autónomos que proporcionen a Copilot información relevante para ayudarle a trabajar en este repositorio. Como las instrucciones se envían con todos los mensajes de chat, deben ser ampliamente aplicables a la mayoría de las solicitudes que realizarás en el contexto del repositorio.

La estructura exacta que uses para los archivos de instrucciones variará según el proyecto y las necesidades, pero las siguientes guías proporcionan un buen punto de partida:

Proporciona información general sobre el proyecto en el que trabajas, incluidos su propósito, objetivos y cualquier información complementaria pertinente.
Especifica los estándares y convenciones de programación que se deban seguir, como convenciones de nomenclatura, reglas de formato y procedimientos recomendados.
Incluye herramientas, bibliotecas o marcos específicos que se usen en el proyecto, junto con cualquier número de versión o configuraciones pertinentes.

El siguiente archivo de instrucciones es un ejemplo de estas prácticas en acción:

# Project Overview

This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.

## Libraries and Frameworks

- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.

## Coding Standards

- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.

## UI guidelines

- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.

También debes tener en cuenta el tamaño y la complejidad del repositorio. Los siguientes tipos de instrucciones pueden funcionar para un repositorio pequeño con solo algunos colaboradores, pero para un repositorio grande y diverso, pueden causar problemas:

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 ejemplo, es posible que las instrucciones siguientes no tengan los resultados previstos:

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.