Contributing

Contributions to tsp are welcome. Some possible contributions are suggested below. Also make sure you read the notes in Instructions for contributors.

Suggestions for contributions

• Better documentation: Do you have a great example or application? Write a documentation page!

• Support for more dataloggers: Do you use a data logger that is not currently supported? Create a new reader for it

• Examples of data logger text file outputs: These are valuable because they help capture the variability of these files ‘in the wild’. This, in turn makes it possible to write better tests and make sure they the readers work for everyone.

• New visualizations

• Add relevant parameters to existing visualizations

• Report any bugs, suggestions or unexpected behaviour to the gitlab issue tracker

Instructions for contributors

• Report any bugs, suggestions or unexpected behaviour to the gitlab issue tracker

• Please follow the python style guide

• Follow the Numpy convention for docstrings. These are automatically converted into web documentation using Sphinx

• Make your code in a separate branch on Gitlab and create a merge request when you think its ready to be added

• Where possible, add tests to make sure your code works as expected and continues to work as expected