Agregar instrucciones personalizadas del repositorio para GitHub Copilot

Esta versión de este artículo sirve para usar instrucciones personalizadas del repositorio en el sitio web de GitHub. Haz clic en las pestañas anteriores para obtener información sobre el uso de instrucciones personalizadas en otros entornos.

Introducción

Las instrucciones personalizadas de repositorio te permiten proporcionar a Copilot instrucciones y preferencias específicas del repositorio. Para más información, consulta Acerca de la personalización de las respuestas de GitHub Copilot.

Requisitos previos para las instrucciones personalizadas del repositorio

• Debes tener un archivo de instrucciones personalizado (consulta las instrucciones a continuación).

• Para revisión de código Copilot, es necesario habilitar la opción de usar instrucciones personalizadas en su configuración personal. Esta opción está habilitada de manera predeterminada. Consulta Cómo habilitar o deshabilitar instrucciones personalizadas del repositorio más adelante en este artículo.

Creación de instrucciones personalizadas

Copilot en GitHub admite tres tipos de instrucciones personalizadas de repositorio. Para obtener más información sobre qué características de GitHub Copilot admiten estos tipos de instrucciones, consulte Acerca de la personalización de las respuestas de GitHub Copilot.

•         **Instrucciones personalizadas para todo el repositorio**, 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. Consulta Creación de instrucciones personalizadas para todo el repositorio.

•         **Instrucciones personalizadas específicas de la ruta de acceso**, 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. Consulta Crear instrucciones personalizadas específicas de la ruta.

  Si la ruta de acceso especificada coincide con un archivo en el que está trabajando Copilot y también existe un archivo de instrucciones personalizadas para todo el repositorio, se usan las instrucciones de ambos archivos.

•           Los agentes de IA usan las **instrucciones del agente**.
  

  Puedes crear uno o más archivos AGENTS.md, almacenados en cualquier lugar del repositorio. Cuando Copilot está en funcionamiento, el archivo AGENTS.md más cercano en el árbol de directorios tendrá prioridad sobre otros archivos de instrucciones del agente. Para obtener más información, consulta el repositorio openai/agents.md.

  Como alternativa, puedes usar un único archivo CLAUDE.md o GEMINI.md almacenado en la raíz del repositorio.

Creación de instrucciones personalizadas para todo el repositorio

Puedes crear tu propio archivo de instrucciones personalizadas desde cero. Consulta Escribir tu propio archivo copilot-instructions.md. Como alternativa, puedes pedir a Agente de programación Copilot que genere uno automáticamente.

Pedirle a Agente de programación Copilot que genere un archivo copilot-instructions.md

1. Vaya a la pestaña agentes en github.com/copilot/agents.

   También puede acceder a esta página haciendo clic en el situado junto a la barra de búsqueda en cualquier página de GitHub; a continuación, seleccione Agents en la barra lateral.

2. Con el menú desplegable del campo de mensaje, seleccione el repositorio para el que quiere que Copilot genere instrucciones personalizadas.

3. Copie la siguiente indicación y péguela en el campo de entrada, personalizándola si es necesario:

   Markdown

   Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently.
   
   You will do this task only one time per repository and doing a good job can SIGNIFICANTLY improve the quality of the agent's work, so take your time, think carefully, and search thoroughly before writing the instructions.
   
   <Goals>
   - Reduce the likelihood of a coding agent pull request getting rejected by the user due to
   generating code that fails the continuous integration build, fails a validation pipeline, or
   having misbehavior.
   - Minimize bash command and build failures.
   - Allow the agent to complete its task more quickly by minimizing the need for exploration using grep, find, str_replace_editor, and code search tools.
   </Goals>
   
   <Limitations>
   - Instructions must be no longer than 2 pages.
   - Instructions must not be task specific.
   </Limitations>
   
   <WhatToAdd>
   
   Add the following high level details about the codebase to reduce the amount of searching the agent has to do to understand the codebase each time:
   <HighLevelDetails>
   
   - A summary of what the repository does.
   - High level repository information, such as the size of the repo, the type of the project, the languages, frameworks, or target runtimes in use.
   </HighLevelDetails>
   
   Add information about how to build and validate changes so the agent does not need to search and find it each time.
   <BuildInstructions>
   
   - For each of bootstrap, build, test, run, lint, and any other scripted step, document the sequence of steps to take to run it successfully as well as the versions of any runtime or build tools used.
   - Each command should be validated by running it to ensure that it works correctly as well as any preconditions and postconditions.
   - Try cleaning the repo and environment and running commands in different orders and document errors and misbehavior observed as well as any steps used to mitigate the problem.
   - Run the tests and document the order of steps required to run the tests.
   - Make a change to the codebase. Document any unexpected build issues as well as the workarounds.
   - Document environment setup steps that seem optional but that you have validated are actually required.
   - Document the time required for commands that failed due to timing out.
   - When you find a sequence of commands that work for a particular purpose, document them in detail.
   - Use language to indicate when something should always be done. For example: "always run npm install before building".
   - Record any validation steps from documentation.
   </BuildInstructions>
   
   List key facts about the layout and architecture of the codebase to help the agent find where to make changes with minimal searching.
   <ProjectLayout>
   
   - A description of the major architectural elements of the project, including the relative paths to the main project files, the location
   of configuration files for linting, compilation, testing, and preferences.
   - A description of the checks run prior to check in, including any GitHub workflows, continuous integration builds, or other validation pipelines.
   - Document the steps so that the agent can replicate these itself.
   - Any explicit validation steps that the agent can consider to have further confidence in its changes.
   - Dependencies that aren't obvious from the layout or file structure.
   - Finally, fill in any remaining space with detailed lists of the following, in order of priority: the list of files in the repo root, the
   contents of the README, the contents of any key source files, the list of files in the next level down of directories, giving priority to the more structurally important and snippets of code from key source files, such as the one containing the main method.
   </ProjectLayout>
   </WhatToAdd>
   
   <StepsToFollow>
   - Perform a comprehensive inventory of the codebase. Search for and view:
   - README.md, CONTRIBUTING.md, and all other documentation files.
   - Search the codebase for build steps and indications of workarounds like 'HACK', 'TODO', etc.
   - All scripts, particularly those pertaining to build and repo or environment setup.
   - All build and actions pipelines.
   - All project files.
   - All configuration and linting files.
   - For each file:
   - think: are the contents or the existence of the file information that the coding agent will need to implement, build, test, validate, or demo a code change?
   - If yes:
      - Document the command or information in detail.
      - Explicitly indicate which commands work and which do not and the order in which commands should be run.
      - Document any errors encountered as well as the steps taken to workaround them.
   - Document any other steps or information that the agent can use to reduce time spent exploring or trying and failing to run bash commands.
   - Finally, explicitly instruct the agent to trust the instructions and only perform a search if the information in the instructions is incomplete or found to be in error.
   </StepsToFollow>
      - Document any errors encountered as well as the steps taken to work-around them.
   
   

4. Click or press Enter.

Copilot will start a new session, which will appear in the list below the prompt box. Copilot will create a draft pull request, write your custom instructions, push them to the branch, then add you as a reviewer when it has finished, triggering a notification.

Writing your own copilot-instructions.md file

1. In the root of your repository, create a file named .github/copilot-instructions.md.

   Create the .github directory if it does not already exist.

2. Add natural language instructions to the file, in Markdown format.

   Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility.

Creating path-specific custom instructions

1. Crea el directorio .github/instructions si no existe todavía.

2. Opcionalmente, cree subdirectorios de .github/instructions para organizar sus archivos de instrucciones.

3. Crea uno o varios archivos NAME.instructions.md, donde NAME indica el propósito de las instrucciones. El nombre de archivo debe terminar con .instructions.md.

4. Al principio del archivo, crea un bloque de texto preliminar que contenga la palabra clave applyTo. Usa la sintaxis global para especificar a qué archivos o directorios se aplican las instrucciones.

   Por ejemplo:

   ---
   applyTo: "app/models/**/*.rb"
   ---
   

   Puedes especificar varios patrones si los separas con comas. Por ejemplo, para aplicar las instrucciones a todos los archivos TypeScript del repositorio, podrías usar el siguiente bloque de texto preliminar:

   ---
   applyTo: "**/*.ts,**/*.tsx"
   ---
   

   Ejemplos de Glob:

   •      `*` - coincidirá con todos los archivos del directorio actual.
     

   •      `**` o `**/*` - coincidirán con todos los archivos en todos los directorios.
     

   •      `*.py` : coincidirá con todos los `.py` archivos del directorio actual.
     

   •      `**/*.py` : coincidirá recursivamente con todos los `.py` archivos de todos los directorios.
     

   •      `src/*.py` : coincidirá con todos los `.py` archivos del `src` directorio. Por ejemplo, `src/foo.py` y `src/bar.py`_pero no_`src/foo/bar.py`.
     

   •      `src/**/*.py` : coincidirá recursivamente con todos los `.py` archivos del `src` directorio. Por ejemplo, `src/foo.py`, `src/foo/bar.py` y `src/foo/bar/baz.py`.
     

   •      `**/subdir/**/*.py` : coincidirá recursivamente con todos los `.py` archivos de cualquier `subdir` directorio a cualquier profundidad. Por ejemplo, `subdir/foo.py`, `subdir/nested/bar.py`, `parent/subdir/baz.py`y `deep/parent/subdir/nested/qux.py`, pero _no_`foo.py` en una ruta de acceso que no contiene un `subdir` directorio.
     

5. De manera opcional, para evitar que el archivo sea usado por Agente de programación Copilot o revisión de código Copilot, agregue la palabra clave excludeAgent al bloque frontmatter. Use "code-review" o "coding-agent".

   Por ejemplo, el siguiente archivo solo lo leerá Agente de programación Copilot.

   ---
   applyTo: "**"
   excludeAgent: "code-review"
   ---
   

   Si la palabra clave excludeAgent no se incluye en el bloque frontmatter, tanto revisión de código Copilot como Agente de programación Copilot usarán sus instrucciones.

6. Agrega las instrucciones personalizadas en lenguaje natural mediante el 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.

          <a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline">
          <span>Sí</span></a><a href="https://docs.github.io/success-test/no.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline"><span>No</span></a>

Instrucciones personalizadas en uso

Las instrucciones del archivo están disponibles para que pueda ser utilizado por Copilot en cuanto guarde el archivo. Las instrucciones son agregadas automáticamente a las solicitudes que envía a Copilot.

In chat de Copilot (github.com/copilot), you can start a conversation that uses repository custom instructions by adding, as an attachment, the repository that contains the instructions file.

Whenever repository custom instructions are used by chat de Copilot, the instructions file is added as a reference for the response that's generated. To find out whether repository custom instructions were used, expand the list of references at the top of a chat response in the Chat panel and check whether the .github/copilot-instructions.md file is listed.

You can click the reference to open the file.

Enabling or disabling custom instructions for revisión de código Copilot

Custom instructions are enabled for revisión de código Copilot by default but you can disable, or re-enable, them in the repository settings on GitHub.com. This applies to Copilot's use of custom instructions for all code reviews it performs in this repository.

1. En GitHub, navegue hasta la página principal del repositorio.

2. Debajo del nombre del repositorio, haz clic en Settings. Si no puedes ver la pestaña "Configuración", selecciona el menú desplegable y, a continuación, haz clic en Configuración.

   

3. In the "Code & automation" section of the sidebar, click Copilot, then Code review.

4. Toggle the “Use custom instructions when reviewing pull requests” option on or off.

Further reading

• Compatibilidad con diferentes tipos de instrucciones personalizadas
• Instrucciones personalizadas—a curated collection of examples
• Uso de instrucciones personalizadas para desbloquear la eficacia de la revisión de código de Copilot