Depois que você cria modelos de problema e pull request no repositório, os contribuidores podem usá-los para abrir problemas ou descrever as alterações propostas nas respectivas pull requests, de acordo com as diretrizes de contribuição do repositório. Para obter mais informações sobre como adicionar diretrizes de contribuição a um repositório, consulte "Configurar diretrizes para contribuidores de repositório".
Você pode criar problemas padrão e modelos de pull request 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."
Modelos de problema
Quando você cria modelos de problemas para seu repositório usando o criador de modelos de problema, os colaboradores podem selecionar o modelo apropriado ao abrirem novos problemas no repositório.
Os modelos de problemas são úteis quando você deseja fornecer orientações para a abertura de problemas, permitindo que os contribuidores especifiquem o conteúdo do seus problemas.
Usando o construtor de modelo, você pode especificar um titulo e a descrição de cada modelo, adicionar o conteúdo do modelo e, ou fazer commit do modelo no branch padrão, ou abrir uma pull request no repositório. O construtor de modelo adiciona automaticamente a markup de página inicial YAML que é necessária para que o modelo apareça na página do novo problema. Para obter mais informações, consulte "Configurando modelos de problema para seu repositório."
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
. Para obter mais informações, consulte "Configurando modelos de problemas para seu repositório."
Os modelos de problema são armazenados no branch padrão do repositório, em um diretório .github/ISSUE_TEMPLATE
oculto. Se você criar um modelo em outro branch, ele não estará disponível para uso dos colaboradores. Os nomes dos arquivos dos modelos de problema não diferenciam maiúsculas e precisam de uma extensão .md. Para ser incluído na lista de perfil da comunidade, os modelos de problemas devem estar localizados na pasta .github/ISSUE_TEMPLATE
e conter campos de name:
válido e sobre:
de YAML front matter válidos.
É possível criar manualmente um único modelo de problema em markdown usando o fluxo de trabalho do modelo de problema e os contribuidores do projeto verão automaticamente o conteúdo do modelo no texto do problema. No entanto, recomendamos usar o construtor de modelos de múltiplas issues atualizados para criar modelos de problema. Para obter mais informações sobre o fluxo de trabalho herdado, consulte Criar manualmente um único modelo de problemas para seu repositório".
Modelos de pull request
Quando você adicionar um modelo de pull request ao repositório, os contribuidores do projeto verão automaticamente o conteúdo do modelo no texto da pull request.
É preciso criar modelos no branch padrão do repositório. Os modelos criados em outros branches não são disponibilizados para uso dos colaboradores. Você pode armazenar o modelo de pull request no diretório raiz visível do repositório, na pasta docs
ou no diretório .github
oculto. Os nomes de arquivo do modelo de pull request não diferenciam maiúsculas de minúsculas e podem ter uma extensão .md ou .txt.
Para obter mais informações, consulte "Criar um modelo de pull request para o repositório".