Criar um modelo de pull request para o seu repositório

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.

Neste artigo

Para saber mais, confira Sobre modelos de problema e pull request.

Crie um subdiretório PULL_REQUEST_TEMPLATE/ em uma das pastas compatíveis para conter vários modelos de solicitações de pull e use o parâmetro de consulta template para especificar o modelo que preencherá o corpo da solicitação de pull. Para saber mais, confira Usar parâmetros de consulta para criar um pull request.

Você pode criar modelos padrão de pull request para sua organização ou conta pessoal. Para saber mais, confira Como criar um arquivo padrão de integridade da comunidade.

Adicionar um modelo de pull request

  1. Em GitHub, acesse a página principal do repositório.

  2. Acima da lista de arquivos, selecione o menu suspenso Add file e clique em Create new file.

    Como alternativa, é possível clicar em na exibição em árvore de arquivos à esquerda.

    Captura de tela da página principal de um repositório realçando "Add file" e o ícone de "sinal de adição", descrito acima, com um contorno laranja.

  3. No campo nome do arquivo:

    • Para tornar o modelo de solicitação de pull visível no diretório raiz do repositório, dê ao modelo de solicitação de pull o nome pull_request_template.md.
    • Para tornar o modelo de solicitação de pull visível no diretório docs do repositório, dê ao modelo de solicitação de pull o nome docs/pull_request_template.md.
    • Para armazenar o arquivo em um diretório oculto, dê ao modelo de solicitação de pull o nome .github/pull_request_template.md.
    • Para criar vários modelos de solicitações de pull e usar o parâmetro de consulta template para especificar um modelo para preencher o corpo da solicitação de pull, digite .github/PULL_REQUEST_TEMPLATE/ e o nome do modelo de solicitação de pull. Por exemplo, .github/PULL_REQUEST_TEMPLATE/pull_request_template.md. Você também pode armazenar vários modelos de solicitações de pull em um subdiretório PULL_REQUEST_TEMPLATE na raiz ou nos diretórios docs/. Para saber mais, confira Usar parâmetros de consulta para criar um pull request.

  4. No texto do novo arquivo, adicione seu modelo de pull request. Esse modelo pode consistir em pedir para incluir:

  5. Clique em Fazer commit das alterações...

  6. No campo "Mensagem do commit", digite uma mensagem curta e relevante que descreva a alteração que você fez no arquivo. Você pode atribuir o commit a mais de um autor na mensagem do commit. Para saber mais, confira Criar um commit com vários autores ou em nome de uma organização.

  7. Abaixo dos campos da mensagem de commit, decida se deseja adicionar seu commit ao ramo atual ou a um novo ramo. Se seu branch atual for o branch-padrão, você deverá optar por criar um novo branch para seu commit e, em seguida, criar um pull request. Para saber mais, confira Como criar uma solicitação de pull.

    Captura de tela de um pull request do GitHub mostrando um botão de opção para fazer commit diretamente na branch principal ou criar uma nova branch. A nova ramificação está selecionada. Os modelos ficam disponíveis para os colaboradores quando são incorporados à ramificação padrão do repositório.

  8. Clique em Fazer commit de alterações ou em Propor alterações.

Leitura adicional