1. You need to fork the GitHub repository.
2. Create you own branch.
3. Be sure to add/update tests and documentation within your patch.

Additionnally, you can install pre-commit to ensure you are doing things well:

$ python -m pip install --upgrade --user pre-commit
$ pre-commit install

You will need tox:

$ python -m pip install --upgrade --user tox

Launch the test suit:

$ tox

# or
$ TOXENV=py37 tox

This will test MSS and ensure a good code quality.

mypy is a compile-time static type checker for Python, allowing optional, gradual typing of Python code. MSS is using special files syntax for type annotations, which means that type annotations are written inside pyi files.

Install required packages:

$ python -m pip install --upgrade --user mypy-lang

$ sh check-types.sh -p mss

To build the documentation, simply type:

$ TOXENV=docs tox