QUALITY_DECLARATION

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

rmf_utils Quality Declaration

The package rmf_utils claims to be in the Quality Level 4 category.

Below are the 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_utils uses semver according to the recommendation for ROS Core packages in the ROS 2 Developer Guide.

Version Stability [1.ii]

rmf_utils 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.

The generated CMake config file is installed and therefore part of the public API.

API Stability Policy [1.iv]

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

ABI Stability Policy [1.v]

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

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

rmf_utils 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_utils follows the recommended guidelines for ROS Core packages in the ROS 2 Developer Guide.

Change Requests [2.i]

rmf_utils requires that all changes occur through a pull request.

Contributor Origin [2.ii]

rmf_utils 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 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_utils does not provide documentation.

Public API Documentation [3.ii]

rmf_utils has some embedded API documentation, but it is not hosted.

License [3.iii]

The license for rmf_utils 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_utils contains partial tests for some of its features. The tests are not run automatically.

Public API Testing [4.ii]

Each part of the public API has tests, and new additions or changes to the public API require tests before being added. They are located in the test directory.

Coverage [4.iii]

rmf_utils tracks code coverage statistics. There is no coverage target currently, but new changes are required to make a best effort to keep or increase coverage before being accepted. Decreases are allowed if properly justified and accepted by reviewers. Code coverage will be improved in the future as time allows.

Current coverage statistics can be viewed here.

Performance [4.iv]

rmf_utils does not test performance.

Linters and Static Analysis [4.v]

rmf_utils 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_utils has no required runtime dependencies.

Optional Direct Runtime ROS Dependencies [5.ii]

rmf_utils has no optional runtime dependencies.

Direct Runtime non-ROS Dependency [5.iii]

rmf_utils does not have any runtime non-ROS dependencies.

Platform Support [6]

Target platforms [6.i]

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

Security [7]

Vulnerability Disclosure Policy [7.i]

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