Contributor Guide

Code of Conduct


🐛 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:[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.


  1. Clone your fork and cd into the project:

    git clone<your-github-username>/unify-client-python
    cd unify-client-python
  2. Create a virtualenv:

    python3 -m venv .venv
    source .venv/bin/activate


See User Guide > Installation for compatible Python versions.


If you place your virtualenv within the project codebase, you must name it .venv for flake8 to know how to exclude it from linting.

  1. Install dev dependencies:

    pip install -e .[dev]


To run all tests:

pytest .

To run specific tests, see these pytest docs .

Editor config

Atom :