Criar documento de "como contribuir"

[joepreludian]

Acho que é importante criarmos um documento no README.md ensinando a reproduzir o environment. Um dos pontos que poderíamos tratar seria:

• Instalação das dependencias com pacotes de desenvolvimento;
• instalação do pre-commit;
• Configuração do pre-commit para avaliar a cada push;

Em suma, criar um guia que gire em torno dos comandos:

$ poetry install --with dev

$ poetry shell

$ pre-commit install  # Para instalar os git-hooks

$ pre-commit run --all-files  # Para rodar os lintings e o black para limpar o código

$ mypy .  # para rodar o teste do mypy

Caso ninguém o faça, eu posso construir =)

[lipe14-ops]

certo é algo realmente importante para o projeto... É sempre bom bom envolver que queira ajudar.

Fique à vontade para a implementação!!!!

[joepreludian]

Essa issue já foi finalizada. =) Podemos encerrar com sucesso.