CONTRIBUTING.md

Mini-guia de Contribuição

O pacote utiliza o padrão pyproject.toml e o Poetry. Para instalar as dependências:

$ poetry install --extras "docs"

Testes

Para rodar os testes apenas com a versão atual do Python:

$ poetry run pytest

Para rodar com todas as versões de Python:

$ poetry run tox

Escrevendo testes de novos adaptadores

Quando criar m novo adaptador, escreva ao menos três casos de teste para o método adjust:

1. Utilizando apenas um argumento (data original)
2. Utilizando dois argumentos (data original mais valor personalizado)
3. Utilizando três argumentos (data original, valor personalizado e data final)

Documentação

Para a documentação, é preciso utilizar o Sphinx:

$ poetry run sphinx-build docs docs/_build

Depois, é só acessar docs/_build/index.html.

Limpeza de arquivos gerados automaticamente

Para limpar os arquivos gerados automaticamente, existe o atalho make clean.