34 lines (21 loc) · 2.21 KB

Contributing to TOM (The Other Me)

We strive to make contributing to this project as easy and transparent as possible.

Development Process

This project is part of the TOM initiative. We actively develop TOM-Platform internally and share stable versions with the open-source community.

Did you find a bug?

Ensure the bug was not already reported by searching on GitHub under Issues for the corresponding repository.
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

Create a fork of the repository and submit a pull request to the corresponding upstream repository¹, titled fix/<issue title>.
Please ensure that the pull request is linked to the issue you created.
Please ensure that the code is well-tested and follows our style guidelines².

Did you develop a new feature?

Open an issue on the corresponding repository¹ with a title and clear description.
Create a fork of the repository and submit a pull request to the corresponding upstream repository¹, titled feat/<issue title>.
Please ensure that the pull request is linked to the issue you created.
Please ensure that the code is well-tested and follows our style guidelines².

Do you want to contribute to the documentation?

Create a fork of the repository and submit a pull request to the corresponding upstream repository¹, titled docs/<brief description of the changes>.
Please ensure that the documentation is well-written and follows our style guidelines².

For more details about the forking workflow, please refer here. ↩ ↩² ↩³ ↩⁴
For more details about the style guidelines, please refer here and here. ↩ ↩² ↩³