Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

50 lines (36 loc) · 2.95 KB
Raw

Contributing to tobac

Welcome! We are very happy that you are interested in our project and thanks for taking time to contribute! :)

Getting Started

Installation & Environment details

You will find them in the README.md.

Tutorials

Tutorials have been prepared to provide you further inside to tobacs functionality. Please have a look in the examples folder.

Documentation

You will find our documentation at https://tobac.readthedocs.io.

Testing

The tests are located in the tests folder.

Reporting Bugs

Please create a new issue on GitHub if it is not listed there, yet.

How to write a good Bug Report?

  • Give it a clear descriptive title.
  • Copy and paste the error message.
  • Describe the steps for reproducing the problem and give an specific example.
  • Optional: Make a suggestion to fix it.

How to Submit Changes

  • Have a look at our roadmap first, to learn about our project goals and check the changelog.md.
  • More details on the code structure and further help for code contributions can be found in our developer guide
  • Before you start a pull request, please make sure that you added numpydoc docstrings to your functions. See docstring example in the developer guide. This way the api documentation will be parsed properly.
  • If it is a larger change or an newly added feature or workflow, please add an example in the example folder or adapt the existing examples there.
  • The code should be PEP 8 compliant, as this facilitates our collaboration. Please use the first stable version (22.6.0) of black to format your code. When you submit a pull request, all files are checked for formatting.
  • The tobac repository is set up with pre-commit hooks to automatically format your code when commiting changes. Please run the command "pre-commit install" in the root directory of tobac to set up pre-commit formatting.

We aim to respond to all new issues/pull requests as soon as possible, however sometimes this is not possible due to work commitments.

Slack

In addition to the workflow here on Github, there's a tobac workspace on Slack tobac-dev.slack.com that we use for some additional communication around the project. Please join us there to stay updated about all things tobac that go beyond the detailed work on the code.