Obrigado por considerar contribuir para o CPE Web Scraper! Este documento fornece diretrizes e instruções para contribuir com o projeto.
Este projeto segue um Código de Conduta que todos os participantes devem respeitar. Por favor, leia CODE_OF_CONDUCT.md antes de contribuir.
- Verifique se o bug já não foi reportado na seção de Issues
- Se não encontrar uma issue aberta, crie uma nova
- Inclua um título e descrição clara
- Adicione o máximo de informações relevantes possível:
- Versão do Node.js
- Sistema operacional
- Passos para reproduzir
- Comportamento esperado
- Comportamento atual
- Logs relevantes
- Verifique se a melhoria já não foi sugerida nas Issues
- Crie uma nova issue descrevendo sua sugestão
- Explique por que esta melhoria seria útil
- Forneça exemplos de como ela funcionaria
- Fork o repositório
- Crie uma branch para sua feature (
git checkout -b feature/MinhaFeature) - Faça suas alterações
- Execute os testes (
npm test) - Commit suas alterações (
git commit -am 'Adiciona MinhaFeature') - Push para a branch (
git push origin feature/MinhaFeature) - Abra um Pull Request
- Siga o estilo de código existente
- Atualize o README.md se necessário
- Adicione testes para novas funcionalidades
- Mantenha um commit por funcionalidade
- Escreva mensagens de commit claras e descritivas
- Use TypeScript
- Siga as regras do ESLint configuradas no projeto
- Mantenha a cobertura de testes
- Documente novas funções e classes
- Use nomes descritivos para variáveis e funções
Se você descobrir uma vulnerabilidade de segurança, NÃO abra uma Issue. Envie um email para walissongois@gmail.com com os detalhes.
Se você tiver alguma dúvida, sinta-se à vontade para abrir uma issue com a tag "question".