Skip to content

Commit

Permalink
docs(contributing): add the guideline for directory structure of the …
Browse files Browse the repository at this point in the history
…header files to be exported

Signed-off-by: Shin-kyoto <58775300+Shin-kyoto@users.noreply.github.com>
  • Loading branch information
Shin-kyoto committed Aug 19, 2024
1 parent bfb5e20 commit 2538ade
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/contributing/coding-guidelines/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,5 +65,7 @@ For Autoware-specific styles, refer to the following:
- cf. [Prefix packages with autoware\_](https://github.com/orgs/autowarefoundation/discussions/4097)
- Add implementations within the `autoware` namespace.
- cf. [Prefix packages with autoware\_, Option 3:](https://github.com/orgs/autowarefoundation/discussions/4097#discussioncomment-8384169)
- The header files to be exported must be placed in the `PACKAGE_NAME/include/autoware/` directory.
- cf. [Directory structure guideline, Exporting headers](./ros-nodes/directory-structure.md#exporting-headers)
- In `CMakeLists.txt`, use `autoware_package()`.
- cf. [autoware_cmake README](https://github.com/autowarefoundation/autoware_cmake/tree/main/autoware_cmake)

0 comments on commit 2538ade

Please sign in to comment.