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

Crie um subdiretório ISSUE_TEMPLATE/ em uma das pastas com suporte para conter vários modelos de problemas e use o parâmetro de consulta template para especificar o modelo que preencherá o corpo do problema. Para obter mais informações, confira "Criar um problema".

Você pode adicionar o YAML frontmatter a cada modelo de problema para preencher previamente o título do problema, adicionar rótulos e responsáveis ​​automaticamente e atribuir ao modelo um nome e uma descrição que serão mostrados no seletor de modelos que as pessoas veem ao criar um novo problema em seu repositório .

Aqui está um exemplo de 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
---

Para serem exibidos com uma marca de verificação na lista de verificação de perfil da comunidade, os modelos de problema precisam estar localizados na pasta .github/ISSUE_TEMPLATE e conter chaves name: e about: válidas no frontmatter do YAML (para modelos de problema definidos em arquivos .md) ou chaves name: e description: válidas (para formulários de problema definidos em arquivos .yml).

Você pode criar modelos de problemas padrão e um arquivo de configuração padrão para modelos de problemas para sua organização ou conta pessoal. Para obter mais informações, confira "Como criar um arquivo padrão de integridade da comunidade".

Adicionar um modelo de problema

1. Em GitHub, acesse a página principal do repositório.

2. Acima da lista de arquivos, selecione o menu suspenso Adicionar arquivo e clique em Criar arquivo.

   Como alternativa, é possível clicar em na exibição em árvore de arquivos à esquerda.

   

3. No campo nome do arquivo:

   • Para tornar o modelo de problema visível no diretório raiz do repositório, digite o nome do issue_template. Por exemplo, issue_template.md.
   • Para tornar o modelo de problema visível no diretório docs do repositório, digite docs/ seguido do nome do issue_template. Por exemplo, docs/issue_template.md.
   • Para armazenar seu arquivo em um diretório oculto, digite .github/ seguido do nome do issue_template. Por exemplo, .github/issue_template.md.
   • Para criar vários modelos de problemas e usar o parâmetro de consulta template para especificar um modelo para preencher o corpo do problema, digite .github/ISSUE_TEMPLATE/ e o nome do modelo de problema. Por exemplo, .github/ISSUE_TEMPLATE/issue_template.md. Você também pode armazenar vários modelos de problemas em um subdiretório ISSUE_TEMPLATE na raiz ou nos diretórios docs/. Para obter mais informações, confira "Criar um problema".

4. No texto do novo arquivo, adicione seu modelo de problema. Pode conter:

   • YAML frontmatter
   • Comportamento esperado e comportamento real
   • Etapas para reproduzir o problema
   • Especificações como versão do projeto, sistema operacional ou hardware

5. Clique em Fazer commit das alterações...

6. No campo "Mensagem do commit", digite uma mensagem curta e relevante que descreva a alteração que você fez no arquivo. Você pode atribuir o commit a mais de um autor na mensagem de commit. Para obter mais informações, confira "Criar um commit com vários autores".

7. Abaixo dos campos de mensagem do commit, opte por adicionar o commit ao branch atual ou a um novo branch. Se seu branch atual for o branch-padrão, você deverá optar por criar um novo branch para seu commit e, em seguida, criar um pull request. Para obter mais informações, confira "Como criar uma solicitação de pull".

   
   Os modelos estão disponíveis para os colaboradores quando eles são mesclados no branch padrão do repositório.

8. Clique em Fazer commit de alterações ou em Propor alterações.

Leitura adicional

• "Sobre modelos de problema e pull request"
• "Configurando modelos de problemas em seu repositório"
• "Criar um problema"