Developer’s Guide 103: Contribution Standards

• Contribute
  • Coding and Repository Standards
  • Project Structure
  • Source Repository Structure
  • Fork and Pull Request

Contribute

Coding and Repository Standards

We are using flake8 (along with some of its plugins) and pylint. Their styles are provided in /tox.ini and /.pylintrc respectively.

tox -e flake8
tox -e pylint

Also, we are using a check-manifest which compares /MANIFEST.in and git structure of the source repository, and finally readme_renderer which checks whether /README.rst can be actually rendered in PyPI website page for Oríon.

tox -e packaging

To run all of expected linters execute:

tox -e lint

Project Structure

TODO

Source Repository Structure

TODO

Fork and Pull Request

Fork Oríon remotely to your Github account now, and start by submitting a Pull Request to us or by discussing an issue with us.