nasa / ogma

Generator of runtime monitors for flight and robotics applications.
Other
335 stars 25 forks source link

Rename ROS2 to ROS 2 in all code and documentation #83

Closed ivanperez-keera closed 1 year ago

ivanperez-keera commented 1 year ago

Description

The code, the documentation, and the README use the terminology ROS2 to refer to ROS 2.

The Open Source Robotics Foundation, Inc. (OSRF) has published specific guidance on how the project should be referred to, and they have indicated that they would want it to be called ROS 2.

Type

Additional context

None.

Requester

Method to check presence of bug

The following grep command finds all occurrences of ROS2:

$ grep -nIHre ROS2 --exclude='CHANGELOG.md'
ogma-cli/ogma-cli.cabal:70:                       <https://ros.org Robot Operating System (ROS2)>
ogma-cli/ogma-cli.cabal:94:                     >  ros                      Generate a ROS2 monitoring application
ogma-cli/ogma-cli.cabal:106:                     - <https://ros.org/ The Robot Operating System (ROS2) web page>.
ogma-cli/src/CLI/CommandROSApp.hs:84:commandDesc = "Generate a ROS2 monitoring package"
ogma-cli/README.md:120:  ros                      Generate a ROS2 monitoring package

Note that we exclude the CHANGELOGs because it does not make much sense to edit old entries for this (it's likely better to be honest about what happened and keep past entries as they are).

Expected result

The command above should show no results.

Desired result

The command above should show no results.

Proposed solution

Rename all instances of ROS2 to ROS 2 in the code, the documentation, and the README.

Further notes

None.

ivanperez-keera commented 1 year ago

Change Manager: Confirmed that the issue exists.

ivanperez-keera commented 1 year ago

Technical Lead: Confirmed that the issue should be addressed.

ivanperez-keera commented 1 year ago

Technical Lead: Issue scheduled for Ogma 1.(0+X).(8+Y).

Fix assigned to: @ivanperez-keera.

ivanperez-keera commented 1 year ago

Implementor: Solution implemented, review requested.

ivanperez-keera commented 1 year ago

Change Manager: Verified that:

ivanperez-keera commented 1 year ago

Change Manager: Implementation ready to be merged.