Contributing to Larq
Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub.
To send a Pull Request please fork Larq Zoo on GitHub. After that clone it to a desired directory:
git clone https://github.com/my-username/larq-zoo.git
Install all required dependencies for local development by running:
cd larq-zoo # go into the directory you just cloned pip install -e ".[tensorflow]" # Installs Tensorflow for CPU # pip install -e ".[tensorflow_gpu]" # Installs Tensorflow for GPU pip install -e ".[test]" # Installs all development dependencies
Run Unit tests
Inside the project directory run:
pytest . -n auto
Increment the version number in
setup.py, and make a PR with that change.
Wait until your PR is reviewed and merged.
Go to the GitHub releases, edit the release notes of the draft release, change the tag to the desired version (e.g.
v0.7.0) and hit "Publish release".