Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.42 KB

contributing.rst

File metadata and controls

38 lines (29 loc) · 1.42 KB

Contributing

.. toctree::
  :maxdepth: 2

  MRPT_Coding_Style.rst
  mrpt_git_branches.rst
  ClangFormat.rst
  ClangFormat_internal.rst
  make_a_mrpt_release.rst


Did you find a bug in MRPT?

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.