Skip to main content

Atualmente o GitHub AE está em versão limitada.

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 "Configurar diretrizes para os contribuidores do repositório".

Modelos de problema

Ao criar modelos de problema para o repositório usando o criador de modelos de problema, os colaboradores podem selecionar o modelo apropriado ao abrir novos problemas no repositório.

Captura de tela da página do novo problema, com vários modelos para escolher.

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 "Configurando modelos de problemas em 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 "Configurando 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 arquivo de modelo de problema não diferenciam maiúsculas de minúsculas e precisam de uma extensão .md. Para serem exibidos com uma marca de verificação na lista de verificação de perfil da comunidade, os modelos de problema precisam estar localizados na pasta .github/ISSUE_TEMPLATE e conter chaves name: e about: válidas no frontmatter do YAML (para modelos de problema definidos em arquivos .md) ou chaves name: e description: válidas (para formulários de problema definidos em arquivos .yml).

É 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, é recomendado usar o criador atualizado de diversos modelos de problemas para criar modelos de problemas. Para obter mais informações sobre o fluxo de trabalho herdado, confira "Criar manualmente um modelo único de problema no 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 "Adicionar uma política de segurança a um 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 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 "Criar modelos de pull request no repositório".