Contributing

• C++ coding style for MRPT
  • General rules
  • Class and filenames
  • Code content and style
• MRPT git branches
• MRPT codebase to comply with ClangFormat
  • Line-wrapping
  • Comply new code with ClangFormat
  • IDEs
  • Past discussion links
• ClangFormat - Developer Instructions
  • Notes on formatting the codebase
  • Porting to a new ClangFormat version
• MRPT release check-list
  • 1) Generate source code packages
  • 2) Create a new Debian package

Did you find a bug in MRPT?

• Ensure it is not already reported by searching:

  • The issues list,

  • The mailing list and

  • Solved questions at stackoverflow.com

Do you want to contribute new code to MRPT?

• Please, read carefully the C++ coding style for MRPT.

• Make sure to be familiar with Git, branches, etc. A starting tutorial can be found here

• Fork in GitHub.

• Recommended: create a new branch with a descriptive name and work on it instead of the default develop branch.

• Send commits to your fork as needed:

  • Commit often.

  • Small commits with a proper description are preferred.

• Verify that your code builds. It will anyway be tested upon pull request by our CI.

• Most changes are relevant enough to be shown in the doc/source/doxygen-docs/changelog.md. Modify it as well to reflect what is new.

• Open a pull-request.