Contribute To 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 your fork with the modifications you want to apply.

• Submit the PR.

Then, a regular developer of the project will review it, inform you if any modifications are needed, and ultimately merge it.

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

Typically, we do two or three releases per year (sometimes four in leap years).

You can also use the GitLab Web IDE to create modifications and submit a PR. However, this is not recommended if you have several modifications or commits to make.

Note

All the Tomotools Suite software uses black and pylint for code formatting and linting.

Note

All the Tomotools Suite software has continuous integration (CI) to ensure that added code doesn’t break existing features.