Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Configuring issue templates for your repository

You can customize the templates that are available for contributors to use when they open new issues in your repository.

You can create default issue templates and a default configuration file for issue templates for your organization. Para obter mais informações, consulte "Criar arquivo padrão de integridade da comunidade para a organização".

Neste artigo

Creating issue templates

  1. No GitHub, navegue até a página principal do repositório.

  2. Under your repository name, click Settings.

    Repository settings button

  3. Na seção "Features" (Recursos), em "Issues" (Problemas), clique em Set up templates (Configurar modelos).

    Botão Start template setup (Iniciar configuração do modelo)

  4. Use o menu suspenso Add template (Adicionar modelo) e clique no tipo de modelo que deseja criar.

    Menu suspenso Add template (Adicionar modelo)

  5. Para visualizar ou editar o modelo antes de fazer commit dele no repositório, clique em Preview and edit (Visualizar e editar).

    Botão Preview and edit (Visualizar e editar)

  6. Para editar o modelo, clique em e digite nos campos para editar o conteúdo.

    Botão Issue template edit (Edição de modelo de problema)

  7. Para definir automaticamente um título de problema padrão, atribua o problema a pessoas com acesso de leitura ao repositório ou aplique etiquetas ao modelo de problema. Informe esses detalhes em "Optional additional information" (Informações adicionais opcionais). Você também pode adicionar esses detalhes no modelo de problema com title, labels ou assignees em um formato de página inicial do YAML.

    Informações adicionais para modelo de problema

  8. Quando tiver terminado de editar e visualizar o modelo, clique em Propose changes (Propor alterações) no canto superior direito da página.

    Botão Propose changes (Propor alterações)

  9. Insira uma mensagem do commit descrevendo as alterações.

    Campo de mensagem do commit do modelo de problema

  10. Abaixo dos campos de mensagem do commit, decida se vai fazer commit do seu modelo diretamente no branch padrão ou se vai criar um branch e abrir uma pull request. Para obter mais informações sobre pull requests, consulte "Sobre pull requests".

    Commit do modelo de problema com opção para mestre ou abrir pull request

  11. Clique em Commit changes (Fazer commit das alterações). Assim que essas alterações passarem por merge no branch padrão, o modelo será disponibilizado para os contribuidores usarem quando abrirem novos problemas no repositório.

Configuring the template chooser

You can customize the issue template chooser that people see when creating a new issue in your repository by adding a config.yml file to the .github/ISSUE_TEMPLATE folder.

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

Note: If you used the legacy workflow to manually create an issue_template.md file and enable blank issues in your config.yml file, the template in issue_template.md will be used when people chose to open a blank issue. If you disable blank issues, the template will never be used.

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: GitHub Community Forum
    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. No GitHub, navegue até a página principal do repositório.

  2. Above the file list, click Create new file.

    The New file button

  3. In the file name field, type .github/ISSUE_TEMPLATE/config.yml.

    Configuration filename

  4. In the body of the new file, type the contents of your configuration file.

    Configuration file content

  5. At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. You can attribute the commit to more than one author in the commit message. For more information, see "Creating a commit with multiple co-authors."

    Mensagem do commit para sua alteração

  6. Abaixo dos campos de mensagem do commit, opte por adicionar o commit ao branch atual ou a um novo branch. If your current branch is master, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a new pull request."

    Opções para fazer commit no branch

  7. Click Propose new file.

    Propose new file button

Leia mais

Pergunte a uma pessoa

Não consegue encontrar o que procura?

Entrar em contato