.. _contributing:

Contributing to Mobile Sim
==========================

The Mobile Sim team is excited to welcome contributions from anyone interested in collaborating. Depending on the contributor's skills and expertise, there are various ways to contribute to the project. We will strive to ensure that all contributions are successfully integrated into Mobile Sim.

Take a peek and dive right in!

- :ref:`Report bugs`
- :ref:`Request features`
- :ref:`Code contributions`
    - Learn about Unreal Engine
    - Before getting started
    - Coding standard
    - Submission
    - Checklist
- Art contributions
- :ref:`Docs contributions`


---------------

.. _report_bugs:

Report bugs
-----------

Issues can be reported in the issue section on GitHub. Before reporting a new bug, make sure to do some checkups.

1. Check if the bug has been reported. Look it up in that same issue section on GitHub.

2. Read the docs. Make sure that the issue is a bug, not a misunderstanding on how is Mobile Sim supposed to work. Read the pages related to the issue in the :ref:`documentation` and take a look at the FAQ page.

---------------

.. _request_features:

Request features
----------------

Ideas for new features are also a great way to contribute. Any suggestion that could improve the users' experience can be submitted in the corresponding GitHub section here.

---------------

.. _code_contributions:

Code contributions
------------------
Before starting hands-on on coding, please check out the issue board to check what is the team already working on, to avoid overlapping. In case of doubt or to discuss how to proceed, please contact one of us (or send an email to mobilesimto@gmail.com).

In order to start working, fork the Mobile Sim repository, and clone said fork in your computer. Remember to keep your fork in sync with the original repository.


.. _docs_contributions:

Docs contributions
------------------

To be continue...