Ir para o conteúdo

Como Contribuir

Branchs

  • As branchs devem ser criadas a partir da branch develop e corresponder a alguma das issues.
  • Devem ser nomeadas seguindo a estrutura:
<numero_da_issue>_<título simplificado da issue fonte>
  • Nota: o nome do artefato deve possuir underlines (_) ao invés de espaço e sem acentuação.

Commits

  • Os commits devem ter títulos significativos.
  • O título deve referenciar a issue a qual o artefato se destina com a seguinte estrutura:
#<numero_da_issue> <descrição pequena e concisa>

Issues

  • Verifique se já não existe uma issue que trata do mesmo problema.
  • A issue deve ser clara no título e descrição.
  • Adicione labels que representam o tipo de artefato que deve ser desenvolvido.
  • As issues devem apresentar a estrutura segundo o template.
[#<numero_da_issue>] <título da tarefa>

Pull requests

  • O título e o comentário devem ser claros.
  • O pull request deve ser relacionado a alguma issue.
  • Adicione labels que representem o tipo de artefato.
  • O template pode ser visto em pull requests.
[#número_da_issue] <título da issue fonte>.

Versionamento

Data Nome Detalhe Versão
24/02/2021 Wagner Martins Inicialização do documento e adição de políticas de contribuição 0.1
02/03/2021 Renato Britto Araujo Atualização das políticas de contribuição e formatação do documento 0.2
04/03/2021 Wagner Martins Atualização do documento baseando-se em recomendações da pull request 0.3