Sobre modelos de problema e pull request

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".

You can create default issue and pull request templates for your organization. For more information, see "Creating a default community health file."

Modelos de problema

Ao criar modelos de problema para o repositório usando o construtor de modelo de problema, os modelos estarão disponíveis para uso dos contribuidores quando estes abrirem novos problemas no repositório.

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. For more information, see "Configuring issue templates for your repository."

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 de arquivo do modelo de problema não diferenciam maiúsculas de minúsculas e precisam de uma extensão .md. To be included in the community profile checklist, issue templates must be located in the .github/ISSUE_TEMPLATE folder and contain valid name: and about: YAML front matter.

É 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, é recomendável usar o construtor atualizado de vários modelos de problema para criar os modelos. 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".