QUALITY_DECLARATION

This document is a declaration of software quality for the rmf_robot_sim_common package, based on the guidelines in REP-2004.

rmf_gazebo_plugins Quality Declaration

This package claims to be in the Quality Level 4 category.

Below are the detailed rationales, notes, and caveats for this claim, organized by each requirement listed in the Package Requirements for Quality Level 4 in REP-2004.

Version Policy [1]

Version Scheme [1.i]

This package uses semver according to the recommendation for ROS Core packages in the ROS 2 Developer Guide.

Version Stability [1.ii]

This package is at a stable version, i.e. >= 1.0.0. The current version can be found in its package.xml, and its change history can be found in its CHANGELOG.

Public API Declaration [1.iii]

This package does not have a public API.

API Stability Policy [1.iv]

This package does not have a public API.

ABI Stability Policy [1.v]

This package does not have a public API.

API and ABI Stability Within a Released ROS Distribution [1.vi]

This package does not have a public API.

Change Control Process [2]

This package follows the recommended guidelines for ROS Core packages in the ROS 2 Developer Guide.

Change Requests [2.i]

This package requires that all changes occur through a pull request.

Contributor Origin [2.ii]

This package uses DCO as its confirmation of contributor origin policy. More information can be found in CONTRIBUTING.

Peer Review Policy [2.iii]

All pull requests must have at least 1 peer review.

Continuous Integration [2.iv]

All pull requests must pass CI on all platforms supported by RMF. The CI checks only that the package builds. The most recent CI results can be seen on the workflow page.

Documentation Policy [2.v]

All pull requests must resolve related documentation changes before merging.

Documentation [3]

Feature Documentation [3.i]

This package is documented in the parent repository’s README.md file.

Public API Documentation [3.ii]

This package does not have a public API.

License [3.iii]

The license for this package is Apache 2.0, the type is declared in the package.xml manifest file, and a full copy of the license is in the repository level LICENSE file.

Quality declaration document [3.v]

This quality declaration is linked in the README file.

This quality declaration has not been externally peer-reviewed and is not registered on any Level 4 lists.

Testing [4]

Feature Testing [4.i]

This package does not have any tests.

Public API Testing [4.ii]

This package does not have a public API.

Coverage [4.iii]

This package does not track coverage statistics.

Performance [4.iv]

This package does not have performance tests.

Linters and Static Analysis [4.v]

This package does not use the standard linters and static analysis tools for its CMake code to ensure it follows the ROS 2 Developer Guide.

Dependencies [5]

Direct Runtime ROS Dependencies [5.i]

This package has the following direct runtime ROS dependencies.

rclcpp

rclcpp is Quality Level 1.

geometry_msgs

geometry_msgs is Quality Level 1.

std_msgs

std_msgs is Quality Level 1.

tf2_ros

tf2_ros does not declare a quality level. It is assumed to be at least Quality Level 3 due to its wide-spread use, history, use of CI, and use of testing.

rmf_fleet_msgs

rmf_fleet_msgs is Quality Level 3.

rmf_dispenser_msgs

rmf_dispenser_msgs is Quality Level 3.

rmf_ingestor_msgs

rmf_ingestor_msgs is Quality Level 3.

rmf_building_map_msgs

rmf_building_map_msgs is Quality Level 3.

Optional Direct Runtime ROS Dependencies [5.ii]

This package does not have any optional direct runtime ROS dependencies.

Direct Runtime non-ROS Dependency [5.iii]

This package has the following runtime non-ROS dependencies.

eigen

eigen does not declare a quality level. It is assumed to be QL1 based on wide-spread use.

Platform Support [6]

This package does not support all of the tier 1 platforms as described in REP-2000. This package supports ROS Foxy.

Security [7]

Vulnerability Disclosure Policy [7.i]

This package conforms to the Vulnerability Disclosure Policy in REP-2006.