Skip to content

Boas Práticas

Vinicius Aguiar edited this page Feb 15, 2024 · 2 revisions

Boas Práticas

No nosso contexto se refere ao uso das ferramentas de pre-commit e github actions para garantir que o código mergeado tenha sempre o mesmo padrão, seja funcional ou estético. Para esse fim se recomenda instalar o projeto via poetry incluindo as dependências de desenvolvimento, e em seguida instalar os pre-commit hooks via código abaixo:

poetry install --with=dev && pre-commit install

Uma vez instalados esses hooks irão executar sempre que um commit for realizado. Atualmente alguns repositórios contam com fluxos que executam testes e checam a formatação de arquivos python, sql e yaml. É recomendado que um pull request seja mergeado apenas após todas as validações tenham finalizado com sucesso.