diff --git a/docs/Development-and-Release.md b/docs/Development-and-Release.md index c31dbae..634f7f4 100644 --- a/docs/Development-and-Release.md +++ b/docs/Development-and-Release.md @@ -10,6 +10,13 @@ The development, versioning and release of Open-RMF follows that of the [ROS 2 p * 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`. * Do not update any changelogs. +### Code Style and C++ conventions + +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: +``` +ament_uncrustify --linelength 80 -c ~/rmf_ws/install/rmf_utils/share/rmf_utils/rmf_code_style.cfg --language C++ path/to/files --reformat +``` + ### Release * Open-RMF binaries for new ROS 2 distributions will be available along with the new release of ROS 2. * 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)