Thanks for your interest in our project. Contributions are always welcome!
We are committed to fostering a welcoming, respectful, and harassment-free environment. Be kind!
If you have questions, ideas or want to report a bug, feel free to open an issue. Or go ahead and open a pull request to contribute code. In order to reduce the burden on our maintainers, please make sure that your code follows our style guidelines outlined below.
This project follows custom code style. Code style is checked as pre-commit hook.
We use pre-commit to enforce usage of tools such as clang-format on commit. This ensures that tools such as clang-format are run on a commit, and thus keeps our repository consistent and makes review easier.
Install all the hooks with:
pre-commit installPre-commit will be then automatically run on changed files in a commit. Additionally, it can also be run manually against all files with:
pre-commit run --all-filesThe Map C++ API uses Doxygen to generate its documentation from the code. Make sure to properly document each header file that is exposed by the component with the use of Doxygen format.