CONTRIBUTING.rst

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'

It is also possible to pass pull/<pr-number>/head to test against a specific PR.

Note

Since tahoe-lafs doesn't have correct version information when installed from a github archive, the packaging in default.nix includes a fake version number. This will need to be update manually at least when the minor version of tahoe-lafs changes.

If you want to test multiple versions, you can add an additional source, pointing at other version

nix-shell --run 'niv add -n tahoe-lafs-next tahoe-lafs/tahoe-lafs --rev "<rev>"'
nix-build tests.nix --argstr tahoe-lafs-source tahoe-lafs-next

--argstr tahoe-lafs-source <...> can also be passed to nix-shell and nix-build default.nix.

nixpkgs

We pin to a nixos channel release, which isn't directly supported by niv (issue). Thus, the pin needs to be update manually. To do this, copy the url and sha256 values from PrivateStorageio's nixpkgs-2105.json into the release2105 entry in nix/sources.json. When this is deployed as part of Privatestorageio, we use the value pinned there, rather than the pin in this repository.