Primeiramente, obrigado por considerar contribuir para a logger-json! Estamos felizes em ter você como parte da nossa comunidade. Este documento contém diretrizes para contribuir com a logger-json e esperamos que facilite o processo para que sua contribuição seja feita de forma eficaz e respeitosa.
Há várias maneiras de você contribuir para o projeto:
- Reportando Bugs: Se você encontrar um bug, por favor, abra uma issue no GitHub usando o template de report de bug. Inclua o máximo de detalhes possível e um código que reproduza o problema, se possível.
- Sugerindo Melhorias: Novas ideias são sempre bem-vindas. Abra uma issue no GitHub usando o template de sugestão de melhoria.
- Enviando Pull Requests: Melhorias de código, correções de bugs, e atualizações de documentação são exemplos de contribuições valiosas. Veja abaixo como preparar seu pull request.
- Fork e Clone: Faça um fork do repositório e clone-o localmente.
- Crie uma Branch: Para novas funcionalidades e correções, crie uma branch baseada em
main:git checkout -b feature/minha-nova-featureougit checkout -b fix/correcao-de-bug. - Faça suas Alterações: Adicione suas alterações e faça commits com mensagens claras e concisas seguindo as melhores práticas.
- Escreva ou Atualize os Testes: Se sua alteração adiciona uma nova funcionalidade ou corrige um bug, escreva novos testes ou atualize os existentes.
- Execute os Testes: Garanta que todos os testes estejam passando.
- Abra um Pull Request: Vá para o GitHub e abra um novo pull request para a branch
main. Preencha a descrição do pull request seguindo o template fornecido. - Revisão de Código: Uma vez que seu pull request é aberto, a comunidade pode revisá-lo. Esteja aberto a receber feedback e fazer as alterações necessárias.
Se você tiver qualquer dúvida ou precisar de ajuda, sinta-se à vontade para abrir uma issue no GitHub com sua pergunta.