Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

63 lines (43 loc) · 1.83 KB
Raw

Contributing to Carmen

Questions and issues

In case if you have any questions please create issue and mark it with label question.

If you have found the bug in the code please provide the following information:

  • Steps to reproduce
  • Actual Behaviour
  • Expected Behaviour Please label appropriate issue with label bug.

Coding Style

Please make sure that your code is following ROS coding style for:

Pull Requests

  • Use one of the closing issue keywords in PR description
  • Make sure that all Continious Integration servers are green

New Packages

Whenever you are introducing new package please create PR with basic structure: CMakeLists.txt and package.xml files. This will allow to decrease size of real code PR.

Messages, Services and Actions

Please put definitions of all messages, services and actions definitions to carmen_msgs package.

Styleguides

Branch names

For feature implementation please use the following format F#No_description. Bug fixing branch should be B#No_description. #No is an issue number in GitHub.

Git Commit Messages

  • All commit messages should shortly describe made by commit
  • When only changing documentation, include [ci skip] in the commit description

Documentation Styleguide

Additional Notes

Code Update

Sometimes after code update from main branch you can have compilation issue. This might be due to new dependencies which are needed for new or updated packages. To get all needed packages do the following.

roscd
cd ../src
sudo apt-get update
depkinetic
catkin_make_here