Obrigado por se interessar em contribuir para este projeto! Este guia ajudará você a entender como você pode contribuir e as práticas recomendadas para enviar contribuições.
Se você encontrou um problema ou tem uma sugestão para melhoria, siga estas etapas:
- Verifique a aba de Issues para garantir que o problema ou sugestão ainda não tenha sido reportado.
- Crie um novo issue e forneça informações detalhadas:
- Uma descrição clara e objetiva do problema ou sugestão.
- Passos para reproduzir o problema (se aplicável).
- Logs ou mensagens de erro (se relevante).
- Informações adicionais, como ambiente de desenvolvimento (versão do sistema, navegador, etc.).
Se você deseja corrigir um bug ou adicionar uma nova funcionalidade:
- Faça um fork do repositório.
- Crie uma nova branch para sua contribuição:
git checkout -b feature/nome-da-feature - Faça suas alterações no código.
- Garanta que você seguiu as práticas de codificação descritas neste guia.
- Teste suas alterações localmente antes de enviar.
- Envie suas alterações:
git commit -m "Descrição clara das alterações" git push origin feature/nome-da-feature - Abra um Pull Request no repositório principal.
Certifique-se de descrever o que você fez, incluindo o motivo e detalhes técnicos. Relacione qualquer issue que sua contribuição resolva, se aplicável.
Você pode ajudar revisando Pull Requests abertos. Leia atentamente o código, teste-o localmente e deixe feedback construtivo para o autor.
Este projeto segue os seguintes padrões:
- Linting: Execute o linter antes de enviar suas alterações:
npm run lint - Formatação: Use Prettier ou outro formatter especificado no projeto.
- Commits: Siga as convenções de commit. Use mensagens claras e concisas, por exemplo:
feat: Adiciona uma nova funcionalidade.fix: Corrige um bug.docs: Atualiza documentação.refactor: Melhora o código sem alterar a funcionalidade.test: Adiciona ou corrige testes.
- Certifique-se de que todos os testes existentes passem antes de enviar o código:
npm test - Adicione testes para quaisquer novas funcionalidades ou correções.
- Dúvidas: Se você tiver dúvidas sobre como contribuir, sinta-se à vontade para abrir um Discussion no repositório ou entrar em contato com a equipe em [email protected].
- Respeito e Colaboração: Lembre-se de seguir nosso Código de Conduta em todas as interações.
Todas as contribuições passarão por uma revisão feita por membros do projeto antes de serem aceitas. Durante a revisão:
- Seja receptivo a feedbacks.
- Atualize sua contribuição conforme necessário.
- Mantenha uma comunicação aberta e respeitosa com os revisores.
Contribuidores são reconhecidos por suas contribuições no repositório, seja através de commits, issues, revisões ou discussões. Muito obrigado por tornar este projeto melhor!
Obrigado por sua contribuição! 🎉