From 423c9ea8d675c9e32c4cd5e6311c271056b54258 Mon Sep 17 00:00:00 2001 From: "Takagi, Isamu" Date: Fri, 2 Jun 2023 17:21:45 +0900 Subject: [PATCH 1/3] docs: update directory structure Signed-off-by: Takagi, Isamu --- .../coding-guidelines/ros-nodes/directory-structure.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/contributing/coding-guidelines/ros-nodes/directory-structure.md b/docs/contributing/coding-guidelines/ros-nodes/directory-structure.md index 653c8487942..f0bc8c94680 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,7 +29,8 @@ ├─ test │ └─ test_foo.cpp ├─ package.xml -└─ CMakeLists.txt +├─ CMakeLists.txt +└─ README.md ``` ### config directory From 44ab26fdc7a4bc8b570192c1c0f663376bcc1908 Mon Sep 17 00:00:00 2001 From: "Takagi, Isamu" Date: Mon, 5 Jun 2023 09:36:45 +0900 Subject: [PATCH 2/3] update Signed-off-by: Takagi, Isamu --- .../ros-nodes/directory-structure.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/contributing/coding-guidelines/ros-nodes/directory-structure.md b/docs/contributing/coding-guidelines/ros-nodes/directory-structure.md index f0bc8c94680..c8f71ab7514 100644 --- a/docs/contributing/coding-guidelines/ros-nodes/directory-structure.md +++ b/docs/contributing/coding-guidelines/ros-nodes/directory-structure.md @@ -33,31 +33,38 @@ └─ README.md ``` -### config directory +### Config directory 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 directory + +Place document files and link from README. + +### Include directory 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 directory Place launch files (`.launch.xml` and `.launch.py`). -### src directory +### Schema directory + +Place parameter definition files. See [parameters](./parameters.md) for details. + +### Src directory Place source files and private header files. -### test directory +### Test directory Place source files for testing. From b9c389ed7f8e312de694efd2ffbc9cc4af51e625 Mon Sep 17 00:00:00 2001 From: "Takagi, Isamu" Date: Mon, 12 Jun 2023 11:06:23 +0900 Subject: [PATCH 3/3] update directory descriptions Signed-off-by: Takagi, Isamu --- .../ros-nodes/directory-structure.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/contributing/coding-guidelines/ros-nodes/directory-structure.md b/docs/contributing/coding-guidelines/ros-nodes/directory-structure.md index c8f71ab7514..386cf939bca 100644 --- a/docs/contributing/coding-guidelines/ros-nodes/directory-structure.md +++ b/docs/contributing/coding-guidelines/ros-nodes/directory-structure.md @@ -33,7 +33,9 @@ └─ README.md ``` -### Config directory +### Directory descriptions + +#### `config` Place configuration files such as node parameters. For ROS parameters, use the extension `.param.yaml`. @@ -41,30 +43,30 @@ 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. -### Doc directory +#### `doc` Place document files and link from README. -### Include directory +#### `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`). -### Schema directory +#### `schema` Place parameter definition files. See [parameters](./parameters.md) for details. -### Src directory +#### `src` Place source files and private header files. -### Test directory +#### `test` Place source files for testing.