Project and Community

First off, thank you for considering contributing to TESS. It is people like you that make TESS such a great platform.

TESS is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into the TESS platform.

Please read this page in it's entirety for details on our code of conduct, and the process for submitting pull requests to us.

Why you should read these guidelines?

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Bug Reports

If you think you have found a bug in TESS, first please make sure that you are testing against the latest version of TESS - your issue may already have been fixed. If not, search our issues list in case a similar issue has already been opened.

It is very helpful if you can prepare a reproduction of the bug. In other words, provide a small test case which we can run to confirm your bug. It makes it easier to find the problem and to fix it. Provide as much information as you can. The easier it is for us to recreate your problem, the faster it is likely to be fixed.

Feature Requests

If you find yourself wishing for a feature that doesn't exist in TESS, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that TESS has today have been added because our users saw the need. Open an issue on our issues list which describes the feature you would like to see, why you need it, and how it should work.

Code Contributions

If you have a bug fix or a new feature that you'd like to contribute to TESS, please find or open an issue about it first. Talk about what you would like to do. It may be that somebody is already working on it, or that there are particular issues that you should know about before implementing the change.

Follow the steps below to submit a PR:

1. Fork and clone the repo
2. Commit your change
3. Test your change
4. Rebase your change
5. Submit a Pull Request

Commit Hygiene

We keep a strict 1:1 correspondence between commits and issues. Our commit messages are formatted in the following fashion:

Component/Feature: Issue description (closes #9999)

Please read our Coding Standards here.

Contributor Licence Agreement

We require outside contributors to sign a Contributor license agreement (or CLA) before we can merge their pull requests. You can find more information on the topic here.

Finally, thank you once again for considering contributing to TESS. Together, we're proud to be developing, nurturing, and shipping TESS and building a community of experts in peer-to-peer energy trading and transactive energy.