Contributor Guide

Code of Conduct

See CODE_OF_CONDUCT.md

🐛 Bug Reports / 🙋 Feature Requests

Please leave bug reports and feature requests as Github issues .

Be sure to check through existing issues (open and closed) to confirm that the bug hasn’t been reported before.

Duplicate bug reports are a huge drain on the time of other contributors, and should be avoided as much as possible.

↪️ Pull Requests

For larger, new features:

Open an RFC issue . Discuss the feature with project maintainers to be sure that your change fits with the project vision and that you won’t be wasting effort going in the wrong direction.

Once you get the green light 🚦 from maintainers, you can proceed with the PR.

Contributions / PRs should follow the Forking Workflow :

  1. Fork it: https://github.com/[your-github-username]/unify-client-python/fork

  2. Create your feature branch:

    git checkout -b my-new-feature

  3. Commit your changes:

    git commit -am 'Add some feature'

  4. Push to the branch:

    git push origin my-new-feature

  5. Create a new Pull Request

We optimize for PR readability, so please squash commits before and during the PR review process if you think it will help reviewers and onlookers navigate your changes.

Don’t be afraid to push -f on your PRs when it helps our eyes read your code.

Install

This project uses poetry as its package manager. For details on poetry, see the official documentation .

  1. Install pyenv:

    curl https://pyenv.run | bash

  2. Clone your fork and cd into the project:

    git clone https://github.com/<your-github-username>/unify-client-python
cd unify-client-python

  3. Use pyenv to install a compatible Python version (3.6 or newer; e.g. 3.7.3):

    pyenv install 3.7.3

  4. Set that Python version to be your version for this project(e.g. 3.7.3):

    pyenv local 3.7.3

  5. Check that your Python version matches the version specified in .python-version:

    cat .python-version
python --version

  6. Install poetry as described here:

    curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python

  7. Install dependencies via poetry:

    poetry install

Run tests

To run all tests:

poetry run pytest .

To run specific tests, see these pytest docs .

Run style checks

To run linter:

poetry run flake8 .

To run formatter:

poetry run black --check .

Run the formatter without the –check flag to fix formatting in-place.

Build docs

To build the docs:

cd docs/
poetry run make html

After docs are build, view them by:

cd docs/ # unless you are there already
open -a 'Google Chrome' _build/html/index.html # open in your favorite browser