Qualquer pessoa pode contribuir com esse projeto ao criar uma issue de uma nova funcionalidade (feature request) ou de aviso de bugs (bug report). Além disso, é possível enviar PRs que estejam relacionados a uma issue existente. Tais PRs serão revisadas por mim (Eduardo Vítor), antes de serem aprovados.
Sim! O projeto atualmente utiliza a convenção de nomes do Python presente nesse link.
As funções para extração de notícias são escritas em Python. Logo, você deve ter um ambiente de desenvolvimento Python instalado em seu computador de acordo com as instruções de instalação para o seu sistema Windows/Linux/Mac. Para adicionar uma nova função de extração de notícias, execute os passos a seguir:
- Faça um fork deste repositório e, com o terminal aberto em um diretório de preferência no seu computador, clone-o e acesse o novo diretório criado com o nome do repositório.
git clone <repositorio_fork>
cd ArapiracaNewsBot
- Instale as bibliotecas requeridas.
pip install -r requirements.txt
-
Edite o arquivo
arapiracanews.py
na sua IDE de preferência para implementar uma nova função de extração. -
Antes de enviar um Pull Request (PR), teste sua função de extração manualmente ao chamá-la dentro do arquivo
arapiracanews.py
.
python3 arapiracanews.py
- Por fim, verifique se seu código passa nos testes unitários do projeto ao executar:
python3 test/tests_suite.py
Obs: Após a aprovação do PR, a funcionalidade será incorporada por mim (Eduardo Vítor) no main.py
que contém a comunicação do bot com a API do Telegram e os comandos que podem ser acessados por meio do bot.