A great first place to join the Community is the Slack channel http://slack.openmined.org.
On https://github.com/OpenMined/PyZPK/issues you can find all open Issues. You can find a detailed explanation on how to work with issues below under Issue Allocation.
To contribute to PyZPK you will need to fork the OpenMined/PyZPK repository. Then you can work risk-free on your fork.
You will just need to fork once. After that you can call git fetch upstream and git pull 'branch-name' before you do your local changes to get the remote changes and be up-to-date
PyGrid uses the python package pre-commit to make sure the correct formatting (black & flake) is applied.
You can install it via pip install pre-commit
Then you just need to call pre-commit install
This can all also be done by running make install_hooks
To sync your fork with the OpenMined/PyZPK repository please see this Guide on how to sync your fork.
If you are new to the project and want to get into the code, we recommend picking an issue with the label "good first issue". These issues should ony require general programming knowledge and little to none insights into the project.
Each issue someone is currently working on should have an assignee. If you want to contribute to an issue someone else is already working on please make sure to get in contact with that person via slack or github and organize yourself.
If you want to work on an open issue, please post a comment telling that you will work on that issue, we will assign you as the assignee then.
Caution: We try our best to keep the assignee up-to-date but as we are all humans with our own schedule delays are possible, so make sure to check the comments once before you start working on an issue even when no one is assigned to it.
You can install most of the dependencies by running pip install -r requirements_dev.txt in dev branch.
You can build grid by running: python setup.py install.
To ensure code quality and make sure other people can understand your changes, you have to document your code. For documentation we are using the Google Python Style Rules which can be found here. A well wrote example can we viewed here.
You documentation should not describe the obvious, but explain what's the intention behind the code and how you tried to realize your intention.
You should also document non self-explanatory code fragments e.g. complicated for-loops. Again please do not just describe what each line is doing but also explain the idea behind the code fragment and why you decided to use that exact solution.
For better merge compatibility each import is within a separate line. Multiple imports from one package are written in one line each.
As with any software project it's important to keep the amount of code to a minimum, so keep code duplication to a minimum!
At any point in time you can create a pull request, so others can see your changes and give you feedback.
Please create all pull requests to the dev branch.
If your PR is still work in progress and not ready to be merged please add a [WIP] at the start of the title.
Example:[WIP] Add logic to compile the submodule libsnark
After each commit GitHub Actions will check your new code against the formatting guidelines (should not cause any problems when you setup your pre-commit hook) and execute the tests to check if the test coverage is high enough.
We will only merge PRs that pass the GitHub Actions checks.
If your check fails don't worry you will still be able to make changes and make your code pass the checks.
Dockerfile is added so users on all systems can get involved in development. Windows developers can start contrbiuting with the help of Docker support.
To build the image: docker build -t pyzpk:test .
To run the image: docker run --rm -it pyzpk:test
To run the code, you can open python interpretor inside the container by typing python3.