Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

43 lines (30 loc) · 1.76 KB

Contribuindo

Guia para contribuir para o projeto.

Issues ou pull requests que não estejam de acordo com este guia serão recusados.

Linguagem

  • Commits devem ser feitos em inglês.
  • Issues, pull requests e revisões podem ser feitas em português para facilitar a comunicação e chegar a um consenso rapidamente.

Desenvolvimento

Inspirado no guia criado pelo @arnaldopereira-luizalabs para o p36.

  • Desenvolva apenas em seu branch.
  • Faça rebase com o master antes de criar pull requests.
  • Faça rebase do master em seu branch diariamente.
  • Faça squash dos seus commits que não estão completos (Work In Progress).

O que não fazer

  • Desenvolver direto no master.
  • Merge de branches no master antes que o código seja revisado.
  • Merge de branches no master antes que todas as discussões tenham se encerrado.
  • Merge de pull requests que tenham reviews pendentes (requested ou ainda não finalizadas)

Commits

  • Faça commits pequenos, que descrevem alterações únicas.
  • Siga as referências sobre como escrever mensagens de commits:
  • Seja breve e suscinto no título das mensagens do commit.
  • Use o corpo da mensagem para explicações adicionais.
  • Se esforce para manter o master o mais limpo possível.

Issues

Use issues para discutir problemas e ideias para o projeto.

  • Descreva qual é o problema em questão.
  • Se possível, dê soluções para o problema.
  • Faça links para código ou para referências a outras issues/pull requests se necessário.