Skip to content

DOC: Add note on naming convention inconsistencies (backport #5918) #5943

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

Merged
merged 1 commit into from
Oct 13, 2025
Merged

DOC: Add note on naming convention inconsistencies (backport #5918) #5943

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions source/The-ROS2-Project/Contributing/Code-Style-Language-Versions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,14 @@ Variable Naming
* rationale: easy to tell the scope of a variable at a glance
* consistency across languages

* **Note on naming conventions**: ROS 2 deviates from the Google C++ Style Guide in several naming areas:

* The Google style guide recommends ``kPascalCase`` for constants (e.g., ``kDaysInAWeek``)
* ROS 2 projects currently use a mix of ``snake_case``, ``PascalCase``, and ``UPPER_CASE`` naming conventions
* This deviation is for historical reasons and consistency with existing ROS codebases
* For new projects, developers should follow the existing conventions in related ROS 2 packages
* When in doubt, prefer consistency with surrounding code over strict adherence to Google style

Function and Method Naming
~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down