Skip to content

Latest commit

 

History

History
13 lines (7 loc) · 1.34 KB

File metadata and controls

13 lines (7 loc) · 1.34 KB

Contributing to Simuzilla

Thank you for your interest in contributing to Simuzilla! We wouldn’t be as successful as we are today without the help of our community. There are many ways to contribute and help improve Simuzilla.

Write Code

Simuzilla is primarily written in C++. You can set up a build environment on UNIX and UNIX-like platforms, including macOS and Linux, as well as Windows. You can also set up a remote build environment from any other operative system.

If you would like to contribute changes to the Simuzilla source code, you must create a merge request. Complete details on doing so can be found on this repository Wiki or by contacting Rui Eduardo Lopes. When you submit a merge request, a series of tests should be run in order to ensure that compiles and conforms to our coding guidelines. The change will also be manually reviewed by a core developer and will be merged when the change passes both reviews.

Write documentation

The Simuzilla User's Guide and Developer's Guide are two documents that are still a work in progress under the docs directory in the main repository. You don't need a complete development environment to contribute to them, but you do need git and a text editor. Documentation updates must be made via a merge request, similar to source code changes.