Estamos animados com sua contribuição! Queremos que contribuir para este projeto seja o mais fácil e transparente possível, seja:
- Relatando um bug
- Discutindo o estado atual do código
- Enviando uma correção
- Propondo novas funções
Usamos o github para hospedar código, rastrear bugs e solicitações de funções, além de aceitar pull requests.
Nós seguimos o Github Flow. Tudo deve ser feito através um pull request
Ficamos muito felizes em receber seus pull requests. Siga os passos abaixo:
- Faça um fork do repositório e crie uma branch a partir da
main. - Se você adicionou um código que deve ser testado, adicione testes.
- Se você alterou as APIs, atualize a documentação.
- Tenha certeza que todos os testes estão passando.
- Lembre-se de usar o lint do projeto.
- Crie seu pull request!
Em resumo, quando você envia alterações de código, seus envios são entendidos sob a mesma licença (MIT License) do projeto.
Reportar bugs usando as issues do Github
Usamos as issues do GitHub para rastrear bugs. Relate um bug abrindo uma nova issue; É muito fácil!
Bons relatórios de bugs geralmente tem:
- Um breve resumo do seu contexo
- Passos para reproduzir
- Seja específico!
- Se possível, disponibilize um exemplo
- O que deveria acontecer
- O que realmente acontece
- Observações (possivelmente incluindo porquê você acha que isso pode estar acontecendo, ou coisas que você tentou que não funcionou)
Este projeto utiliza a licença MIT - veja o arquivo LICENSE para mais detalhes.
Esse documento foi adaptado a partir template do
Brian A. Danielak