QUALITY_DECLARATION

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

rmf_building_sim_common Quality Declaration

The package rmf_building_sim_common 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]

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

Version Stability [1.ii]

rmf_building_sim_common 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]

All symbols in the installed headers are considered part of the public API.

All installed headers are in the include directory of the package. Headers in any other folders are not installed and are considered private.

API Stability Policy [1.iv]

rmf_building_sim_common will not break public API within a major version number.

ABI Stability Policy [1.v]

rmf_building_sim_common will not break public ABI within a major version number.

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

rmf_building_sim_common will not break public API or ABI within a released ROS distribution, i.e. no major releases into the same ROS distribution once that ROS distribution is released.

Change Control Process [2]

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

Change Requests [2.i]

rmf_building_sim_common requires that all changes occur through a pull request.

Contributor Origin [2.ii]

rmf_building_sim_common 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]

rmf_building_sim_common does not provide feature documentation.

Public API Documentation [3.ii]

rmf_building_sim_common does not provide API documentation.

License [3.iii]

The license for rmf_building_sim_common 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]

rmf_building_sim_common does not have any feature tests.

Public API Testing [4.ii]

rmf_building_sim_common does not have any API tests.

Coverage [4.iii]

rmf_building_sim_common does not track coverage statistics.

Performance [4.iv]

rmf_building_sim_common does not have performance tests.

Linters and Static Analysis [4.v]

rmf_building_sim_common 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]

rmf_building_sim_common has the following direct runtime ROS dependencies.

rclcpp

rclcpp is Quality Level 1.

rmf_door_msgs

rmf_door_msgs is Quality Level 3.

rmf_lift_msgs

rmf_lift_msgs is Quality Level 3.

rmf_building_map_msgs

rmf_building_map_msgs is Quality Level 3.

Optional Direct Runtime ROS Dependencies [5.ii]

rmf_building_sim_common does not have any optional direct runtime ROS dependencies.

Direct Runtime non-ROS Dependency [5.iii]

menge_vendor

menge_vendor does not declare a quality level. It is assumed to be Quality Level 4.

Platform Support [6]

rmf_building_sim_common does not support all of the tier 1 platforms as described in REP-2000. rmf_building_sim_common supports ROS Eloquent and ROS Foxy.

Security [7]

Vulnerability Disclosure Policy [7.i]

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