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"
.
Adicionar um modelo de problema
-
No GitHub Enterprise, navegue até a página principal do repositório.
-
Above the file list, click Create new file.
-
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
. - 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
. - 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
. - 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órioISSUE_TEMPLATE
(MODELO_DE_PROBLEMA) nos diretórios raiz oudocs/
. Para obter mais informações, consulte "Sobre automação de problemas e pull requests com parâmetros de consulta".
- 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,
-
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
-
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."
-
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."Os modelos são disponibilizados para os colaboradores quando sofrem merge no branch padrão do repositório. -
Click Propose new file.