Contribute

1. Make a difference

Sirius Web, being an open source project, encourages everyone to contribute to its development. You can contribute to Sirius Web in different ways, including:

  • Joining the active community forum,

  • Identifying and reporting bugs,

  • Proposing new features,

  • Enhancing the documentation,

  • Writing comprehensive tests,

  • Fixing existing issues.

2. Get involved

2.1. Joining the forum

For any questions or inquiries, don’t hesitate to contribute in the forum on GitHub.

2.2. Sharing your feedback

Your feedback is crucial to the continuous improvement of Sirius Web. If you believe something is missing, meet strange behavior, or want to express your satisfaction with the current state, feel free to share your thoughts.

2.3. Reporting issues

Bug reports are essential, so report any issues you meet. When reporting bugs, offer detailed descriptions, reproducible tests, example code, or any other relevant information that can aid in resolving the issue.

The issue tracker is hosted on GitHub: https://github.com/eclipse-sirius/sirius-web/issues.

To submit a new issue, you’ll need a GitHub account. For guidance on searching for issues, see GitHub’s help page.

2.4. Enriching the documentation

Have you found errors or inconsistencies in the documentation? We welcome your contributions.

Sirius Web’s documentation can be found on GitHub: https://github.com/eclipse-sirius/sirius-web/tree/master/doc.

Clone the repository, update the documentation, and trigger a pull request. The documentation is written in AsciiDoc syntax, making it straightforward to contribute. Refer to the developer guide’s Documentation section for insights into the documentation building process.

3. Contributing to the code

Sirius Web leverages GitHub for code hosting, enabling straightforward retrieval and source-code builds. Clone the repository, make your modifications, align them with Sirius Web requirements, and start a pull request.

Follow the developer guide to gain insights into setting up your development environment and get started with contributing to the Sirius Web codebase.

Embark on your Sirius Web contribution journey today.

4. Sponsoring Sirius Web

We invite organizations to join us in supporting the ongoing development and enhancement of Sirius Web. Your sponsorship can help us expand the capabilities of this open source project, ensuring it continues to meet the needs of the system engineering community. If you are interested in sponsoring Sirius Web, please reach out to us to discuss sponsorship opportunities and how your support can make a difference.