CONTRIBUTING.md

How to Contribute

• Reach out to us on our public Slack channel.
• If you run into any issues, let us know by creating a GitHub issue.

Testing

We have a handful of GitHub actions to check code and run tests, but most of our testbeds consist of Python unittest. Please write Python unittest for new code that you create.

Submitting Changes

• When submitting changes, make sure that you increment the version number in setup.py. The version number is documented as such in the setup.py file.
• We follow semantic versioning.
• For bug fixes, increment the patch version (last number).
• For backward compatible changes to the API, update the minor version (second number), and zero out the patch version.
• For breaking changes to the API, increment the major version (first number) and zero out the minor and patch versions.

Coding Conventions

Start reading our code and you'll get the hang of it. We use linters and the following and code checks:

• Install Linters

  python -m pip install -U flake8 flake8-colors
  python -m pip install -U flake8-import-order pep8-naming
  python -m pip install -U pydocstyle pylint

• Install Extra Dependencies

  python -m pip install -U Deprecated requests tdigest

• Run Flake8 Checks

  python -m flake8

• Run PyLint Checks

  python -m pylint -d duplicate-code wavefront_sdk

• Run PyDocStyle

  python -m pydocstyle

• Execute Unit Tests

  python -m unittest discover