Configuring issue templates for your repository

Puedes crear plantillas de informe de problemas predeterminadas y un archivo de configuración predeterminado para éstas para tu cuenta de organización o de usuario. Para obtener más información, consulta "Crear un archivo de salud predeterminado para la comunidad."

Creating issue templates

1. En GitHub.com, visita la página principal del repositorio.
2. Debajo de tu nombre de repositorio, da clic en Configuración.
3. In the "Features" section, under "Issues," click Set up templates.
4. Use the Add template drop-down menu, and click on the type of template you'd like to create.
5. To preview or edit the template before committing it to the repository, click Preview and edit.
6. To edit the template, click , and type in the fields to edit their contents.
7. To automatically set a default issue title, assign the issue to people with read access to the repository, or apply labels to your issue template, enter these details under "Optional additional information." You can also add these details in the issue template with title, labels, or assignees in a YAML frontmatter format.
8. When you're finished editing and previewing your template, click Propose changes in the upper right corner of the page.
9. Enter a commit message describing your changes.
10. Below the commit message fields, decide whether to commit your template directly to the default branch, or to create a new branch and open a pull request. For more information about pull requests, see "About pull requests."
11. Click Commit changes. Once these changes are merged into the default branch, the template will be available for contributors to use when they open new issues in the repository.

Creating issue forms

With issue forms, you can create issue templates that have customizable web form fields. You can encourage contributors to include specific, structured information by using issue forms in your repository. Issue forms are written in YAML using the GitHub form schema. For more information, see "Syntax for GitHub's form schema." Si eres nuevo en YAML y quieres aprender más, consulta la guía "Aprende YAML en Y minutos".

To use an issue form in your repository, you must create a new file and add it to the .github/ISSUE_TEMPLATE folder in your repository.

Here is an example of an issue form configuration file.

name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
assignees:
  - octocat
body:
  - type: markdown
    attributes:
      value: |
        Thanks for taking the time to fill out this bug report!
  - type: input
    id: contact
    attributes:
      label: Contact Details
      description: How can we get in touch with you if we need more info?
      placeholder: ex. email@example.com
    validations:
      required: false
  - type: textarea
    id: what-happened
    attributes:
      label: What happened?
      description: Also tell us, what did you expect to happen?
      placeholder: Tell us what you see!
      value: "A bug happened!"
    validations:
      required: true
  - type: dropdown
    id: version
    attributes:
      label: Version
      description: What version of our software are you running?
      options:
        - 1.0.2 (Default)
        - 1.0.3 (Edge)
    validations:
      required: true
  - type: dropdown
    id: browsers
    attributes:
      label: What browsers are you seeing the problem on?
      multiple: true
      options:
        - Firefox
        - Chrome
        - Safari
        - Microsoft Edge
  - type: textarea
    id: logs
    attributes:
      label: Relevant log output
      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
      render: shell
  - type: checkboxes
    id: terms
    attributes:
      label: Code of Conduct
      description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
      options:
        - label: I agree to follow this project's Code of Conduct
          required: true

Here is the rendered version of the issue form.

1. Choose a repository where you want to create an issue form. You can use an existing repository that you have write access to, or you can create a new repository. For more information about creating a repository, see "Creating a new repository."
2. In your repository, create a file called .github/ISSUE_TEMPLATE/FORM-NAME.yml, replacing FORM-NAME with the name for your issue form. For more information about creating new files on GitHub, see "Creating new files."
3. In the body of the new file, type the contents of your issue form. For more information, see "Syntax for issue forms."
4. Commit your file to the default branch of your repository. For more information, see "Creating new files."

Configuring the template chooser

Puedes personalizar el selector de plantilla de informe de problemas que ven las personas cuando crean un nuevo informe de problemas en tu repositorio si añades un archivo config.yml a la carpeta .github/ISSUE_TEMPLATE.

You can encourage contributors to use issue templates by setting blank_issues_enabled to false. If you set blank_issues_enabled to true, people will have the option to open a blank issue.

If you prefer to receive certain reports outside of GitHub, you can direct people to external sites with contact_links.

Here is an example config.yml file.

blank_issues_enabled: false
contact_links:
  - name: Soporte de la Comunidad de GitHub
    url: https://github.community/
    about: Please ask and answer questions here.
  - name: GitHub Security Bug Bounty
    url: https://bounty.github.com/
    about: Please report security vulnerabilities here.

Your configuration file will customize the template chooser when the file is merged into the repository's default branch.

1. En GitHub.com, visita la página principal del repositorio.
2. En la parte superior de la lista de archivos, utilizando el menú desplegable de Agregar archivo, da clic en Crear archivo nuevo.
3. In the file name field, type .github/ISSUE_TEMPLATE/config.yml.
4. In the body of the new file, type the contents of your configuration file.
5. En la parte inferior de la página, teclea un mensaje de confirmación corto y significativo que describa el cambio que realizaste al archivo. Puedes atribuir el cambio a mas de un autor en el mensaje del mismo. Para obtener más información, consulta "Crear una confirmación con co-autores múltiples".
6. Debajo de los campos del mensaje de confirmación, decide si deseas agregar tu confirmación a la rama actual o a una rama nueva. Si tu rama actual es la rama predeterminada, debes elegir crear una nueva rama para tu confirmación y después crear una solicitud de extracción. Para obtener más información, consulta "Crear una solicitud de extracción nueva".
7. Da clic en Proponer nuevo archivo.

Further reading

• "About issue and pull request templates"
• "Manually creating a single issue template for your repository"