Contributing

Install dependencies

Install development dependencies:

poetry install --with=dev

If you also want to modify documents, install related documents:

poetry install --with=dev --with=docs

If the client is modified for a new verion's schema, run the code generator:

rm -r src/binaryai/client_stub && \
poetry run ariadne-codegen

We use Sphinx for document generation. After modified texts, you should re-generate the LOCALE files:

cd docs/
make getpo

And you can modify *.po files. To have a preview:

make all

Run following commands before commit:

poetry run flake8 . && \
poetry run black --line-length=120 . && \
poetry run isort --profile=black --line-length=120 .