Configurando modelos de problemas em seu repositório

Você pode criar modelos de problemas-padrão e um arquivo de configuração-padrão para os modelos de problema para a sua organização ou conta de usuário. Para obter mais informações, consulte "Criando um arquivo padrão de integridade da comunidade."

Criando modelos de problemas

1. No GitHub, navegue até a página principal do repositório.
2. No nome do seu repositório, clique em Configurações.
3. Na seção "Features" (Recursos), em "Issues" (Problemas), clique em Set up templates (Configurar modelos).
4. Use o menu suspenso Add template (Adicionar modelo) e clique no tipo de modelo que deseja criar.
5. Para visualizar ou editar o modelo antes de fazer commit dele no repositório, clique em Preview and edit (Visualizar e editar).
6. Para editar o modelo, clique em e digite nos campos para editar o conteúdo.
7. Para definir automaticamente um título de problema padrão, atribua o problema a pessoas com acesso de leitura ao repositório ou aplique etiquetas ao modelo de problema. Informe esses detalhes em "Optional additional information" (Informações adicionais opcionais). Você também pode adicionar esses detalhes no modelo de problema com title, labels ou assignees em um formato de página inicial do YAML.
8. Quando tiver terminado de editar e visualizar o modelo, clique em Propose changes (Propor alterações) no canto superior direito da página.
9. Insira uma mensagem do commit descrevendo as alterações.
10. Abaixo dos campos de mensagem do commit, decida se vai fazer commit do seu modelo diretamente no branch padrão ou se vai criar um branch e abrir uma pull request. Para obter mais informações sobre pull requests, consulte "Sobre pull requests".
11. Clique em Commit changes (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.

Criando formulários de problema

Com formulários de problemas, é possível criar modelos de problemas com campos personalizáveis de formulário web. É possível incentivar os contribuidores a incluir informações específicas e estruturadas usando formulários de problemas no seu repositório. Os formulários de problemas são escritos em YAML usando o esquema de formulário de GitHub. Para obter mais informações, consulte "Sintaxe para o esquema de formulário de GitHub". Se você é novo no YAML e deseja aprender mais, consulte "Aprenda YAML em Y minutes".

Para usar um formulário de problema no seu repositório, é necessário criar um novo arquivo e adicioná-lo à pasta .github/ISSUE_TEMPLATE no seu repositório.

Aqui está um exemplo de um arquivo de configuração do formulário de problema.

name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
assignees:
  - octocat
body:
  - type: markdown
    attributes:
      value: |
        Thanks for taking the time to fill out this bug report!
  - type: input
    id: contact
    attributes:
      label: Contact Details
      description: How can we get in touch with you if we need more info?
      placeholder: ex. email@example.com
    validations:
      required: false
  - type: textarea
    id: what-happened
    attributes:
      label: What happened?
      description: Also tell us, what did you expect to happen?
      placeholder: Tell us what you see!
      value: "A bug happened!"
    validations:
      required: true
  - type: dropdown
    id: version
    attributes:
      label: Version
      description: What version of our software are you running?
      options:
        - 1.0.2 (Default)
        - 1.0.3 (Edge)
    validations:
      required: true
  - type: dropdown
    id: browsers
    attributes:
      label: What browsers are you seeing the problem on?
      multiple: true
      options:
        - Firefox
        - Chrome
        - Safari
        - Microsoft Edge
  - type: textarea
    id: logs
    attributes:
      label: Relevant log output
      description: Please copy and paste any relevant log output. Isso será formatado automaticamente em código. Portanto, não há necessidade de barra inversa.
      render: shell
  - type: checkboxes
    id: terms
    attributes:
      label: Code of Conduct
      description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
      options:
        - label: I agree to follow this project's Code of Conduct
          required: true

Aqui está a versão renderizada do formulário de problema.

1. Escolha um repositório em que você deseja criar um formulário de problema. Você pode usar um repositório existente ao qual você tem acesso de gravação ou criar um novo repositório. Para obter mais informações sobre como criar um repositório, consulte "Criar um repositório".
2. No repositório, crie um arquivo denominado .github/ISSUE_TEMPLATE/FORM-NAME.yml, substituindo FORM-NAME pelo nome do formulário do problema. Para obter mais informações sobre como criar novos arquivos no GitHub, consulte "Criar novos arquivos".
3. No texto do novo arquivo, digite o conteúdo do formulário de seu problema. Para obter mais informações, consulte "Sintaxe para os formulários de problema".
4. Faça o commit do seu arquivo para o branch padrão do seu repositório. Para obter mais informações, consulte "Criar arquivos".

Configurando o seletor de modelos

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

Você pode incentivar os contribuidores a usar modelos de problemas definindo blank_issues_enabled para falso. Se você configurar blank_issues_enabled para verdadeiro, as pessoas terão a opção de abrir um problema em branco.

Se você preferir receber determinados relatórios fora de GitHub, você pode direcionar pessoas para sites externos com contact_links.

Aqui está um exemplo de arquivo config.yml.

blank_issues_enabled: false
contact_links:
  - name: Suporte à Comunidade GitHub
    url: https://github.community/
    about: Pergunte e responda dúvidas aqui.
  - name: GitHub Recompensa de bug de segurança
    url: https://bounty.github.com/
    about: Reporte vulnerabilidades de segurança aqui.

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

1. No GitHub, navegue até a página principal do repositório.
2. Acima da lista de arquivos, utilizando o menu suspenso Add file (Adicionar arquivo), clique em Create new file (Criar novo arquivo).
3. No campo 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 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, consulte "Criar um commit com vários co-autores."
6. 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, consulte "Criar uma nova pull request."
7. Clique em Propose new file.

Leia mais

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