Contribute code#

How to contribute#

The best way to submit a Pull Request (PR) to tomwer is to:

  • fork the project from the gitlab interface

  • create a branch on you fork with the modification you want to apply

  • submit the PR

Then a regular developer of the project will review it, let you know if it needs some modification and ultimately merge it.

If this is an important bug fix a minor release will be made else you will benefit from it on the next release.

Usually we do two or three releases per year (sometime four on leap years).

You can also use the gitlab Web IDE to create modifications and create a PR. Not recommended if you have several modificaitons / commits to do.

Note

All the Tomotools suite software is using black and pylint.

Note

All the Tomotools suite software have continuous integration CI to make sure added code won’t break exiting features.