Skip to content

Latest commit

 

History

History
30 lines (16 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

30 lines (16 loc) · 1.55 KB

Contributing to Larq Compute Engine

👍 🎉 First off, thanks for taking the time to contribute! 👍 🎉

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub.

Ask a question or raise an issue

If you have questions about Larq Compute Engine or just want to say Hi you can chat with us on Spectrum.

If something is not working as expected, if you run into problems with Larq Compute Engine or if you have ideas for missing features, please open a new issue.

Project setup

See our build guide to get started.

Code style

We use clang-format, black and buildifier to format all of our code.

Publish LCE converter pip package

  1. Increment the version number in setup.py, and make a PR with that change.

  2. Wait until your PR is reviewed and merged.

  3. 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".

  4. A GitHub action will automatically publish a release to PyPI based on the tag.