Skip to main content

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.

Este é o fluxo de trabalho de legado para criar um modelo de problemas. Recomendamos o uso do construtor de modelos de problema atualizado ou formulários de problema para criar modelos de problema. Para obter mais informações, confira "Sobre os modelos de solicitação de pull e de problema".

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 "Sobre a automação para problemas e solicitações de pull com parâmetros de consulta".

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

Observação: se um valor de front matter incluir um caractere reservado pelo YAML, como :, você precisará colocar todo o valor entre aspas. Por exemplo, ":bug: Bug" ou ":new: triage needed, :bug: bug".

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. On your GitHub Enterprise Server instance, navigate to the main page of the repository. 1. Acima da lista de arquivos, usando o menu suspenso Adicionar arquivo, clique em Criar arquivo. "Criar arquivo" no menu suspenso "Adicionar arquivo"
  2. 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. Novo nome de modelo de problema no diretório raiz
    • 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, Novo modelo de problema no diretório docs
    • Para armazenar seu arquivo em um diretório oculto, digite .github/ seguido do nome do issue_template. 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 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 "Sobre a automação para problemas e solicitações de pull com parâmetros de consulta". Vários novos modelos de problemas no diretório oculto
  3. 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 1. No final da página, digite uma mensagem de commit curta e significativa que descreva a alteração feita no arquivo. Você pode atribuir o commit a mais de um autor na mensagem de commit. Para obter mais informações, confira "[Como criar um commit com vários coautores](/articles/creating-a-commit-with-multiple-authors)".
    
    Mensagem de commit para a alteração 1. 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". Opções de commit no branch Os modelos estão disponíveis para os colaboradores quando eles são mesclados no branch padrão do repositório.
  4. Clique em Propor novo arquivo. Botão Propor novo arquivo

Leitura adicional