CONTRIBUTING.md

Table of Contents

• Contributing to TSGM
• Development
• Documenting

Contributing to TSGM

Thanks for your interest and willingness to help!

Please, (1) open an issue for a new feature or comment on the existing issue in the issue tracker, (2) open a pull request with the issue (see the list of pull request).

The easiest way to make a pull request is to fork the repo, see GitHub documentation.

Development

To install TSGM in development mode, first install prerequisites:

pip install -r requirements/requirements.txt
pip install -r requirements/tests_requirements.txt
pip install -r requirements/docs_requirements.txt

and then, install TSGM in development mode:

python setup.py develop

To run tests, use pytest, for example:

pytest tests/test_cgan.py::test_temporal_cgan

To run linters, use:

flake8 tsgm/

Documenting

We aim to produce high-quality documentation to help our users to use the library. In your contribution, please edit corresponding documentation pages in ./docs.

To build the documentation, use:

cd docs
make html