Template Pull Request

Utilização

Para utilizar o template, siga as instruções abaixo:

1. Crie um diretório chamado .github na raiz do seu repositório.
2. Dentro do diretório .github, crie um arquivo chamado PULL_REQUEST_TEMPLATE.md.
3. Agora você pode adicionar o conteúdo Orientações para Pull Requests ao arquivo PULL_REQUEST_TEMPLATE.md, que servirá como modelo para os pull requests no seu repositório e automaticamente a estrutura será montada como no exemplo.

Orientações para Pull Requests

Descrição da Feature

Esta seção deve conter um resumo claro e conciso da mudança proposta neste pull request. Explique o problema que está sendo corrigido ou a funcionalidade que está sendo adicionada. Inclua também informações sobre a motivação por trás dessas alterações.

Problema Corrigido

Descreva o problema específico que está sendo abordado por este pull request. Explique o cenário em que o problema ocorre e por que é necessário corrigi-lo. Se houver um problema registrado ou conhecido relacionado a essa questão, faça referência a ele aqui.

Motivação e Contexto

Forneça uma explicação detalhada sobre a motivação por trás deste pull request. Explique como essa alteração beneficia o projeto, os usuários ou outras partes interessadas. Forneça contexto relevante, como informações sobre o fluxo de trabalho atual, limitações existentes ou requisitos específicos que influenciaram a abordagem adotada.

Dependências

Se houver dependências específicas para este pull request, como outras alterações de código, pacotes ou bibliotecas externas, mencione-as nesta seção. Isso ajudará a identificar quaisquer pré-requisitos necessários para que essa alteração funcione corretamente.

Como isso foi testado?

Descreva os testes que foram realizados para verificar as alterações feitas neste pull request. Inclua detalhes sobre a configuração de teste e os resultados obtidos. Certifique-se de mencionar qualquer teste automatizado, testes manuais ou outras estratégias de verificação que tenham sido aplicadas.

• Teste A
• Teste B

Informações adicionais:

• Meu código segue as diretrizes de estilo deste projeto
• Eu revisei meu próprio código
• Eu comentei o meu código, especialmente em áreas de difícil compreensão
• Eu fiz as alterações correspondentes na documentação
• Minhas alterações não geram novos avisos
• Quaisquer alterações dependentes foram mescladas e publicadas em módulos dependentes

Consulte em outros idiomas

---

Utilidades

Utilização das Branches com Git Flow

Orientação para Git Signature

Orientação para Conventional Commits

Conventional Commits Extensão

Git Commitizen

Utilização Semantic Version

Semantic Version Official

Templete Pull Request