Guidelines - EmaroLab/docs GitHub Wiki

Rules for structuring ROS workspaces

  1. A workspace must be contained in a single folder (a ROS package) and organized in sub-packages. (user created ones)
ros_ws/
├── src/
│   ├── user_defined_package
│   │   ├── sub_package_1
│   │   ├── sub_package_2
│   │   ├── ...
│   │   ├── common_msgs_package
│   │   └── doc
│   │  
│   └── (...other packages...)
│
└── (...other folders...)

  1. User-defined messages used by more than one package have to be defined in a separate ROS sub-package.

  2. When creating ROS packages, the output of the program has to be published on a topic. At least user-defined messages that are published to the output topic, have to be contained in the sub-package (the common_msgs_package) mentioned in the previous item. The input/output topics must be listed in the ReadMe.

>> Here you can find a tutorial on how to manage a project with subrepositories. <<

Rules for ReadMe creation

For each project you have to follow this ReadMe.md example.

Rules for gitignore

It is advised to use this .gitignore to keep projects tidy and clean.