Templates de report

Cadastre textos-base de título e descrição por tipo de report, para quem reporta usar ou ignorar.

Quem faz: administrador ou Mantenedor.

Um template é um texto-base de título e descrição, definido por projeto e por tipo (Bug, Melhoria ou Sugestão). Na captura, ele aparece como sugestão nos campos vazios. Quem reporta usa o template ou escreve do zero. O template não obriga nada.

Criar um template

  1. Abra Configurações do projeto → Templates, no grupo Reports.
  2. Clique em Adicionar no grupo do tipo (Bug, Melhoria ou Sugestão), que abre o formulário com esse tipo escolhido.
  3. Confira o Tipo e dê um nome, como Erro no checkout. O nome só aparece para quem gerencia os templates e no seletor da captura.
  4. Preencha o Título, a Descrição ou os dois. Informe ao menos um. A descrição é Markdown, então títulos como ## Passos e listas numeradas funcionam.
  5. Clique em Criar template.

Um exemplo de descrição para bugs:

## O que aconteceu

## O que eu esperava

## Passos para repetir
1.
Seção Templates das configurações do projeto, com um template de bug
Os templates ficam agrupados por tipo. Cada linha mostra o nome, o título e o começo da descrição.

Ordem e limite

Cada tipo tem a própria lista. Passe o mouse sobre uma linha para ver as setas que sobem ou descem o template. Clique na linha para editar, ou abra o menu de três pontos para Editar ou Remover. O primeiro da lista é o que a captura seleciona primeiro. O projeto aceita até 20 templates, e o contador N de 20 mostra o uso. No limite, remova um para criar outro.

Como aparece na captura

  • Com um só template no tipo, o texto vira o placeholder do título e da descrição. No campo vazio e focado, Tab preenche o campo e deixa editar. Escape logo depois desfaz.
  • Logo depois do texto do template na descrição fica uma barra com o nome do template e Usar, que preenche os dois campos de uma vez.
  • Com mais de um template no tipo, as setas da barra trocam de template (1/2, 2/2), e o primeiro da ordem vem selecionado. A barra some quando a descrição ganha texto.

A extensão, o widget e o Novo report do dashboard usam o mesmo formulário e os mesmos templates.

Editar e remover

Editar um template não muda os reports já criados, e um rascunho aberto mantém o texto já preenchido. Remover um template também não apaga o texto dos reports que o usaram. A detecção de duplicados ignora as linhas da descrição iguais às do template, para que o texto comum não faça reports diferentes parecerem iguais.

Próximos passos

Nesta página