Contributing¶

Reporting Issue & Submitting a Patch¶

We use dalibo/temboard-agent to track issue and review contribution. Fork the main repository and open a PR against master as usual.

Refer to temBoard UI CONTRIBUTING.

Sphinx generates temBoard agent documentation.

$ cd docs/
$ pip install -r requirements-doc.txt
$ make watch

Now run make serve in another terminal and point your web browser at http://0.0.0.0:8000/. There is no auto-refresh.

Releasing a new version of temBoard agent requires write access to master on main repository, PyPI project and Docker Hub repository.

For the tooling, you need Git 1.8+, a recent setuptools with wheel, and twine. For debian packaging, see below.

Please follow these steps:

Checkout the release branch, e.g. v2.
Choose the next version according to PEP 440 .
Update temboardagent/version.py, without committing.
Generate commit and tag with make release.
Push Python egg to PyPI using make upload.
Build and push RPM packages using make -C packaging/rpm all push.
Build and push debian packages using make -C packaging/deb all push.
Trigger docker master build from https://hub.docker.com/r/dalibo/temboard-agent/~/settings/automated-builds/.