Configurando modelos de problemas em seu repositório

Criando modelos de problemas

1. No sua empresa, navegue até a página principal do repositório. 1. Abaixo do nome do repositório, clique em Configurações. Caso não consiga ver a guia suspensa "Configurações", selecione o menu suspenso e clique em Configurações.

   

2. Na seção "Recursos", em Problemas, clique em Configurar modelos. Talvez seja necessário habilitar Problemas e atualizar a página para você ver o botão.

3. Use o menu suspenso Adicionar modelo e clique no tipo de modelo que deseja criar.

   

4. Para visualizar ou editar o modelo antes de fazer commit dele no repositório, clique em Visualizar e editar.

5. Para editar o modelo, clique em e digite os campos para editar o conteúdo.

   

6. Para definir automaticamente um título de problema padrão, atribua o problema a pessoas com acesso de leitura ao repositório ou aplique rótulos aos problemas levantados por meio do modelo usando os campos em "Informações adicionais opcionais". Adicione também esses detalhes no modelo de problema com title, labels ou assignees em um formato de frontmatter YAML.

7. Quando terminar de editar e visualizar o modelo, clique em Propor alterações no canto superior direito da página.

8. No campo "Mensagem de commit", digite uma mensagem de commit que descreva as alterações.

9. Abaixo dos campos de mensagem do commit, selecione se vai fazer commit do modelo diretamente no branch padrão ou se vai criar um branch e abrir uma solicitação de pull. Para obter mais informações sobre as solicitações de pull, confira "Sobre solicitação de pull".

10. Clique em Fazer commit das alterações. Assim que essas alterações passarem por merge no branch padrão, o modelo será disponibilizado para os contribuidores usarem quando abrirem novos problemas no repositório.

Configurando o seletor de modelos

Você pode personalizar o seletor de modelo de problema que as pessoas veem ao criar um problema no seu repositório adicionando um arquivo config.yml à pasta .github/ISSUE_TEMPLATE.

Você pode incentivar os colaboradores a usar modelos de problema definindo blank_issues_enabled como false. Se você definir blank_issues_enabled como true, as pessoas terão a opção de abrir um problema em branco.

Se preferir receber determinados relatórios fora do GitHub AE, você poderá direcionar as pessoas para sites externos com contact_links.

Este é um exemplo de arquivo config.yml.

blank_issues_enabled: false
contact_links:
  - name: GitHub Community Support
    url: https://github.com/orgs/community/discussions
    about: Please ask and answer questions here.
  - name: GitHub Security Bug Bounty
    url: https://bounty.github.com/
    about: Please report security vulnerabilities here.

Seu arquivo de configuração customizará o seletor de modelos quando o arquivo for mesclado ao branch padrão do repositório.

1. No sua empresa, navegue até a página principal do repositório.

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

3. No campo de nome do arquivo, digite .github/ISSUE_TEMPLATE/config.yml.

4. No corpo do novo arquivo, digite o conteúdo do seu arquivo de configuração.

5. 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". 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". 1. Clique em Fazer commit de alterações ou em Propor alterações.

Leitura adicional

• "Sobre modelos de problema e pull request"
• "Criar manualmente um modelo único de problema no repositório"