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.

Criar manualmente um modelo único de problema no repositório

Ao adicionar um modelo de problema criado manualmente no repositório, os colaboradores de projetos verão automaticamente o conteúdo do modelo no texto do problema.

Neste artigo

This is the legacy workflow to create an issue template. We recommend using the upgraded multiple issue template builder to create multiple issue templates. Para obter mais informações, consulte "Sobre modelos de problema e pull request".

Você pode criar um subdiretório ISSUE_TEMPLATE/ (MODELO_DE_PROBLEMA) em qualquer uma das pastas compatíveis. Assim, é possível incluir vários modelos de problemas e usar o parâmetro de consulta template (modelo) para especificar o modelo que irá preencher o texto do problema. Para obter mais informações, consulte "Sobre automação de problemas e pull requests com parâmetros de consulta".

You can add YAML frontmatter to each issue template to pre-fill the issue title, automatically add labels and assignees, and give the template a name and description that will be shown in the template chooser that people see when creating a new issue in your repository.

Here is example YAML front matter.

---
name: Tracking issue
about: Use this template for tracking new features.
title: "[DATE]: [FEATURE NAME]"
labels: tracking issue, needs triage
assignees: octocat, octo-org/octo-team
---

Note: You must put YAML-reserved characters such as : in quotes. For example, ":bug: Bug".

To be included in the community profile checklist, issue templates must be located in the .github/ISSUE_TEMPLATE folder and contain valid name: and about: YAML front matter.

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".

Adicionar um modelo de problema

  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. No campo nome do arquivo:

    • Para que seu modelo de problema seja visível no diretório raiz do repositório, digite o nome de seu issue_template (modelo_de_problema). Por exemplo, issue_template.md.
      Novo nome de modelo de problema no diretório raiz
    • Para que seu modelo de problema seja visível no diretório docs do repositório, digite docs/ seguido pelo nome de seu issue_template (modelo_de_problema). Por exemplo, docs/issue_template.md.
      Novo modelo de problema no diretório docs
    • Para armazenar seu arquivo em um diretório oculto, digite .github/ seguido do nome de seu issue_template (modelo_de_problema). Por exemplo, .github/issue_template.md.
      Novo modelo de problema no diretório oculto
    • Para criar vários modelos de problemas e usar o parâmetro de consulta template (modelo) para especificar um modelo para preencher o texto do problema, digite .github/ISSUE_TEMPLATE/ (.github/MODELO_DE_PROBLEMA) e o nome de seu modelo de problema. Por exemplo, .github/ISSUE_TEMPLATE/issue_template.md. Também é possível armazenar vários modelos de problemas em um subdiretório ISSUE_TEMPLATE (MODELO_DE_PROBLEMA) nos diretórios raiz ou docs/. Para obter mais informações, consulte "Sobre automação de problemas e pull requests com parâmetros de consulta".
      Vários novos modelos de problemas no diretório oculto
  4. No texto do novo arquivo, adicione seu modelo de problema. Pode conter:

    • YAML frontmatter
    • Comportamento esperado e comportamento atual
    • Etapas para reproduzir o problema
    • Especificações, como a versão do projeto, sistema operacional ou hardware
  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 Os modelos são disponibilizados para os colaboradores quando sofrem merge no branch padrão do repositório.

  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