Skip to content
Snippets Groups Projects
After you've reviewed these contribution guidelines, you'll be all set to contribute to this project.
CONTRIBUTING.rst 2.52 KiB

Contributing to ZKAPAuthorizer

Contributions are accepted in many forms.

Examples of contributions include:

  • Bug reports and patch reviews
  • Documentation improvements
  • Code patches

File a ticket at:

https://github.com/PrivateStorageio/ZKAPAuthorizer/issues/new

ZKAPAuthorizer uses GitHub keep track of bugs, feature requests, and associated patches.

Contributions are managed using GitHub's Pull Requests. For a PR to be accepted it needs to have:

  • an associated issue
  • all CI tests passing
  • patch coverage of 100% as reported by codecov.io

Updating Dependencies

We use niv to manage several of our dependencies.

Python Dependencies

We use mach-nix to build python packages. It uses a snapshot of pypi to expose python dependencies to nix, thus our python depedencies (on nix) are automatically pinned. To update the pypy snapshot (and thus our python dependencies), run

nix-shell --run 'niv update pypi-deps-db'

tahoe-lafs

We depend on pinned commit of tahoe-lafs. To update to the latest commit, run

nix-shell --run 'niv update tahoe-lafs --branch master'