Skip to main content

Sobre modelos de problema e pull request

Com modelos de problema e pull request, é possível personalizar e padronizar as informações que deseja que os contribuidores incluam quando abrem problemas e pull requests no seu repositório.

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, confira "Diretrizes de configuração para colaboradores do repositório".

Modelos de problema

Quando você cria modelos de problemas para seu repositório usando o construtor de modelos de problemas, os colaboradores podem selecionar o modelo apropriado quando abrem novos problemas no repositório.

Página de novo problema mostrando opções do modelo de problema

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, confira "Como configurar modelos de problemas para seu repositório".

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. Para obter mais informações, confira "Como configurar modelos de problemas em seu repositório".

Os modelos de problemas 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 arquivos do modelo de problema não diferenciam maiúsculas de minúsculas e precisam ter uma extensão .md. Para serem incluídos na lista de verificação de perfil da comunidade, os modelos de problemas precisam estar localizados na pasta .github/ISSUE_TEMPLATE e conter os front matters YAML name: e about: 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 vários modelos de problemas atualizado para criar modelos de problemas. Para obter mais informações sobre o fluxo de trabalho herdado, confira "Como criar manualmente um modelo de problema individual para seu repositório".

Você pode criar uma política de segurança para dar às pessoas instruções para relatar vulnerabilidades de segurança no seu projeto. Para obter mais informações, confira "Como adicionar uma política de segurança ao 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.

Exemplo de modelo de 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 solicitação de pull no diretório raiz visível do repositório, na pasta docs ou no diretório .github oculto. Os nomes de arquivos do modelo de solicitação de pull não diferenciam maiúsculas de minúsculas e podem ter uma extensão, como .md ou .txt.

Para obter mais informações, confira "Como criar um modelo de solicitação de pull para seu repositório".