How can I contribute

Everyone is most welcome to contribute to the Rebel Toolbox. Here are some ways in which you can contribute to the project:

• Reporting issues <https://github.com/RebelToolbox/RebelEngine/issues>`__.

• Writing or proofreading documentation. You can contribute both to this reference manual or the code reference.

• Improving the engine by fixing bugs, coding new features, or refining existing ones.

Getting started

You would like to contribute but you don't know how or what to do? You can get answers below.

• Ways to contribute

Writing documentation

We always need help to improve the documentation, be it the API documentation or the manual. Below, you can find our content and writing guidelines and concrete guides to make changes to the documentation.

Guidelines

Here are the principles and guidelines we strive to follow to write accessible documentation.

• Content guidelines
• Docs writing guidelines
• Documentation guidelines

Writing the manual

• Contributing to the documentation
• Building Rebel Documentation with Sphinx

API Documentation

The pages below focus on the API documentation.

As the reference is included in the Rebel Engine editor, its source files are part of the Rebel Engine repository. We use XML files to write it, so the process to contribute to the API documentation differs from writing the online manual.

• Contributing to the Rebel Engine API Documentation
• API writing guidelines

Contributing to the engine

The guides below explain how to contribute to the engine's core. You will learn about the code style, the contribution workflow, and more.

• Best practices for engine contributors
• Pull request workflow
• Testing pull requests
• Bisecting regressions
• Bug triage guidelines
• Code style guidelines
• C++ usage guidelines