Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adds a note about C++ code style. #425

Merged
merged 2 commits into from
Feb 28, 2024
Merged

Adds a note about C++ code style. #425

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93130c6
Add a note about C++ code style.
arjo129 Feb 7, 2024
ae56f49
Update Development-and-Release.md
arjo129 Feb 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/Development-and-Release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading