CONTRIBUING.md

Guia de contribuição

WeeeeeeeW! Que legal que você quer contribuir com esse projeto! Ficamos muito felizes em saber disso ❤️

Por onde começar?

Se você estiver meio perdida por onde começar a contribuir, dê uma olhada em algumas issues que temos abertas. Caso você tenha achado a Issue pouco detalhada, não exite em comentar, alguém irá te responder assim que possível.

Após você ter escolhido uma Issue ou aberto uma nova, comente nela avisando para outras pessoas que você está trabalhando nela. Após isso faça um fork desse projeto e crie uma nova branch.

Não esqueça de seguir as boas práticas desse projeto.

Bugs?

Se você encontrou algum bug no nosso bot, antes de reportar ele como issue, verifique se ele já foi reportado antes ou se ele está sendo corrigido.

Caso ele ainda não tenha sido reportado, abra uma issue e detalhe bem qual o bug e como ele aconteceu. Se você tiver referências que possam ajudar na correção, compartilhe, vamos adorar.

Boas práticas

Aqui você encontrará algumas boas práticas para contribuir com esse projeto.

• Não esqueça de avisar na Issue que você está trabalhando nela, é importânte manter todo mundo alinhado;
• Se tiver dúvida avise, alguém irá lhe responder assim que possível;
• Instalar as dependências do projeto;
• Testar as alterações que você fez;
• Escrever mensagens de commit no presente, exemplo: "Atualiza o README.md" e não "Atualizado o README.md";
• Escrever mensagem de commit em português, mas tentar desenvolver o código o máximo possível em inglês;
• Detalhar o que você fez na descrição do Pull Request.

Caso você tenha instalado uma nova biblioteca, não esqueça de subir o arquivo pyproject.toml e o requirements.txt atualizado. Se você não sabe, é possível criar um requirements.txt a partir de um pyproject.toml, veja mais sobre isso aqui.

Se você achou que está faltando algo nesse documento. Nós avise ou abra um pull request, vamos adorar ter a sua contribuição.