diff --git a/docs/contributing/coding-guidelines/ros-nodes/directory-structure.md b/docs/contributing/coding-guidelines/ros-nodes/directory-structure.md index 653c8487942..386cf939bca 100644 --- a/docs/contributing/coding-guidelines/ros-nodes/directory-structure.md +++ b/docs/contributing/coding-guidelines/ros-nodes/directory-structure.md @@ -11,12 +11,17 @@ ├─ config │ ├─ foo_ros.param.yaml │ └─ foo_non_ros.yaml +├─ doc +│ ├─ foo_document.md +│ └─ foo_diagram.svg ├─ include │ └─ -│ └─ foo_public.hpp +│ └─ foo_public.hpp ├─ launch │ ├─ foo.launch.xml │ └─ foo.launch.py +├─ schema +│ └─ foo_node.schema.json ├─ src │ ├─ foo_node.cpp │ ├─ foo_node.hpp @@ -24,34 +29,44 @@ ├─ test │ └─ test_foo.cpp ├─ package.xml -└─ CMakeLists.txt +├─ CMakeLists.txt +└─ README.md ``` -### config directory +### Directory descriptions -Place configuration files such as node parameters. +#### `config` +Place configuration files such as node parameters. For ROS parameters, use the extension `.param.yaml`. For non-ROS parameters, use the extension `.yaml`. Rationale: Since ROS parameters files are type-sensitive, they should not be the target of some code formatters and linters. In order to distinguish the file type, we use different file extensions. -### include directory +#### `doc` + +Place document files and link from README. + +#### `include` Place header files exposed to other packages. Do not place files directly under the `include` directory, but place files under the directory with the package name. This directory is used for mostly library headers. Note that many headers do not need to be placed here. It is enough to place the headers under the `src` directory. Reference: -### launch directory +#### `launch` Place launch files (`.launch.xml` and `.launch.py`). -### src directory +#### `schema` + +Place parameter definition files. See [parameters](./parameters.md) for details. + +#### `src` Place source files and private header files. -### test directory +#### `test` Place source files for testing.