Skip to content

Commit

Permalink
Add config and launch directories to recommended package layout (#1139)
Browse files Browse the repository at this point in the history
These two directories seem common enough, and already a convention,
that we should consider adding them to the recommended package layout.

Signed-off-by: Jacob Perron <jacob@openrobotics.org>
(cherry picked from commit 5eb270f)
  • Loading branch information
jacobperron authored and mergify-bot committed Feb 25, 2021
1 parent 27a5c5b commit 2300f97
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions source/Contributing/Developer-Guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,9 @@ Package layout

* ``<package_name>``: contains all Python code
* ``test``: contains all automated tests and test data
* ``config``: contains configuration files, e.g. YAML parameters files and RViz config files
* ``doc``: contains all the documentation
* ``launch``: contains all launch files
* ``package.xml``: as defined by `REP-0140 <https://www.ros.org/reps/rep-0140.html>`_ (may be updated for prototyping)
* ``CMakeLists.txt``: only ROS packages which use CMake
* ``setup.py``: only ROS packages which use Python code only
Expand Down

0 comments on commit 2300f97

Please sign in to comment.