Guia para contribuir para o projeto.
Issues ou pull requests que não estejam de acordo com este guia serão recusados.
- 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.
- Desenvolva apenas em seu branch.
- Faça rebase com a master antes de criar pull requests.
- Faça squash dos seus commits que não estão completos (Work In Progress).
- Evite fazer alterações que mude a API para matermos a retrocompatibilidade. (Caso necessário explique o porquê no pull request)
- Faça commits pequenos, que descrevem alterações únicas.
- Adicione testes sempre que possível
- 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.
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.