Skip to content

Commit 1c08ff4

Browse files
authored
Adds a note about C++ code style. (#425)
Signed-off-by: Arjo Chakravarty <arjoc@intrinsic.ai>
1 parent 3a89397 commit 1c08ff4

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/Development-and-Release.md

+7
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ The development, versioning and release of Open-RMF follows that of the [ROS 2 p
1010
* Only patch version bumps are allowed on distro branches. This is to ensure distro branch versions do not increase higher than newer distros or `main`.
1111
* Do not update any changelogs.
1212

13+
### Code Style and C++ conventions
14+
15+
We require that all C++ code follows the conventions laid out [here](). `colcon test` will automatically check for deviations of style. If you'd like to have you're code autoformatted you can run the following command:
16+
```
17+
ament_uncrustify --linelength 80 -c ~/rmf_ws/install/rmf_utils/share/rmf_utils/rmf_code_style.cfg --language C++ path/to/files --reformat
18+
```
19+
1320
### Release
1421
* Open-RMF binaries for new ROS 2 distributions will be available along with the new release of ROS 2.
1522
* Roughly monthly, patch releases for packages with changes will be available in source and binary forms. All releases will be announced [here](https://github.com/open-rmf/rmf/releases)

0 commit comments

Comments
 (0)