Contributing¶
Thanks for looking into making zksk better! It’s currently under active development, and we are grateful for any help, bug reports, fixes, and new primitives.
Dev setup¶
Package¶
Checkout the repository, and run in the directory:
pip install -e ".[dev]"
This will install the dev version of the locally checked-out package
Docs¶
To build the documentation pages run:
cd docs/
make html
They will be built in docs/_build/html
. You can run any static server to check them. For
example:
cd docs/_build/html
python -m http.server
Hooks¶
We use pre-commitment hooks for automatic code formatting. Set them up as follows:
pre-commit install
Issues¶
Please create an issue on Github if you spot a bug or other problem.