Como criar formulários de categoria de discussão

Você pode personalizar os modelos disponíveis para os membros da comunidade usarem quando abrirem novas discussões em seu repositório.

Neste artigo

Sobre formulários de categoria de discussão

Você pode incentivar os membros da comunidade a incluir informações específicas e estruturadas em suas discussões usando formulários de discussão em seu repositório. Com os formulários de categoria de discussão, você pode criar modelos de discussão com campos de formulário da Web personalizáveis. Os formulários de discussão são escritos em YAML usando o esquema de formulário GitHub Para saber mais, confira Sintaxe para o esquema de formulário do GitHub.

Se você não estiver familiarizado com o YAML e quiser saber mais, confira "Aprenda a usar o YAML em Y minutos".

Para usar um formulário de categoria de discussão em seu repositório, você deve criar um arquivo /.github/DISCUSSION_TEMPLATE/ e adicioná-lo à pasta em seu repositório.

Você também pode criar formulários de categoria de discussão para sua organização. Para saber mais, confira Como criar um arquivo padrão de integridade da comunidade.

Não há suporte para formulários de categoria de discussão para enquetes. Para obter mais informações sobre enquetes, confira Sobre discussões.

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

Captura de tela de um formulário de categoria de discussão renderizado.

Como criar formulários de categoria de discussão

Pessoas com acesso de gravação a um repositório podem criar um formulário de categoria de discussão.

  1. Navegue até o repositório em que você deseja criar um formulário de categoria de discussão.
  2. Em seu repositório, crie um arquivo chamado /.github/DISCUSSION_TEMPLATE/FORM-NAME.yml, substituindo FORM-NAME pelo nome do seu formulário de categoria de discussão. O nome deve corresponder ao slug de uma de suas categorias de discussão. Por exemplo, o modelo para a categoria "Comunicados" deve ser .github/DISCUSSION_TEMPLATE/announcements.yml. Para obter mais informações sobre como criar arquivos no GitHub, confira Criar arquivos.
  3. No corpo do novo arquivo, digite o conteúdo do formulário de categoria de discussão. Para saber mais, confira Sintaxe para formulários de categoria de discussão.
  4. Faça o commit do seu arquivo para o branch padrão do seu repositório. Para saber mais, confira Criar arquivos.