Diretrizes de Pull Request

Para garantir um processo de revisão suave e eficiente, tanto os colaboradores e revisores devem aderir às seguintes diretrizes ao enviar e analisar Pull Requests (PR).

Para Colaboradores

1. Títulos e Descrições Descritivos
   • Use títulos claros e concisos que resumem as alterações.
   • Forneça descrições detalhadas do que o PR faz, pois as alterações são necessárias e qualquer contexto relevante.
2. Link para Problemas
   • No título do seu PR, adicione GH-ISSUE-NUMBER para vincular o PR ao problema destacado. Isso é necessário para todos os PRs.
3. Pequenas, Mudanças Focais
   • Mire para manter os PRs pequenos e focados em uma única questão ou recurso. Isso ajuda os revisores a entenderem melhor e a oferecerem comentários.
4. Qualidade do Código
   • Assegure que seu código obedeça aos padrões de codificação e às melhores práticas do projeto.
   • Inclua comentários quando necessário para explicar uma lógica complexa.
5. Testando
   • Teste suas alterações minuciosamente antes de enviar o PR.
   • Se aplicável, inclua testes de unidade ou testes de integração para verificar suas alterações.
6. Documentação
   • Atualize e/ou adicione documentação conforme necessário para refletir suas alterações.
7. Mensagens de Commit
   • Use mensagens de commit claras e descritivas que seguem o formato convencional de commits.
8. Verificar se há conflitos
   • Antes de enviar seu PR, certifique-se de que seu branch está atualizado com o branch base para minimizar conflitos de merge.

Para revisores

• Espera-se que reveja profundamente a RP e solicite alterações, se necessário.
• Forneça sugestões e sugestões construtivas para melhorar.
• Verifique se as mudanças atendem aos padrões de codificação e melhores práticas do projeto.
• Instale o PR usando a integração com dokploy para garantir que as mudanças funcionem conforme o esperado.
• Certifique-se de que a documentação seja atualizada conforme necessário.
• Aprovar o RP somente quando você estiver satisfeito com as alterações e todas as verificações tiverem passado.