Contributing

  • We are interested in various different kinds of improvement for Photon; please feel free to raise an Issue if you would like to work on something major to ensure efficient collaboration and avoid duplicate effort.
  • Create a topic branch from where you want to base your work.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure you have added tests for your changes.
  • Run all the tests to ensure nothing else was accidentally broken.
  • Reformat the code by following the formatting section below.
  • Submit a pull request.

Testing

Dependencies

Install the test framework Tox.

$ pip install tox

Unit

Unit tests are invoked by Tox.

$ tox

Formatting

The formatting is done using YAPF.

From the root for the project, run:

$ tox -e format