QUALITY_DECLARATION

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

`resource_retriever_service` Quality Declaration

The package resource_retriever_service claims to be in the Quality Level 3 category.

Below are the rationales, notes, and caveats for this claim, organized by each requirement listed in the Package Quality Categories in REP-2004 of the ROS2 developer guide.

Version Policy [1]

Version Scheme [1.i]

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

Version Stability [1.ii]

resource_retriever_service 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 considered private.

API Stability Policy [1.iv]

resource_retriever_service will not break public API within a released ROS distribution, i.e. no major releases once the ROS distribution is released.

ABI Stability Policy [1.v]

resource_retriever_service contains C code and therefore must be concerned with ABI stability, and will maintain ABI stability within a ROS distribution.

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

resource_retriever_service will not break API nor ABI within a released ROS distribution, i.e. no major releases once the ROS distribution is released.

Change Control Process [2]

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

Change Requests [2.i]

All changes will occur through a pull request, check ROS 2 Developer Guide for additional information.

Contributor Origin [2.ii]

We don’t have any extra measure above what is used within the github pull requests.

Peer Review Policy [2.iii]

All pull request will be peer-reviewed, check ROS 2 Developer Guide for additional information.

Continuous Integration [2.iv]

All pull request must pass CI on all tier 1 platforms

Currently nightly results can be seen here:

Documentation Policy [2.v]

All pull requests must resolve related documentation changes before merging.

Documentation [3]

Feature Documentation [3.i]

resource_retriever_service has its features documented inside the header files of the relevant APIs.

Public API Documentation [3.ii]

resource_retriever_service has documentation of its public API within the header files of the relevant APIs.

License [3.iii]

The license for resource_retriever_service is Apache 2.0, and a summary is in each source file, the type is declared in the package.xml manifest file, and a full copy of the license is in the LICENSE file.

There is an automated test which runs a linter that ensures each file has a license statement. Here can be found a list with the latest results of the various linters being run on the package.

Copyright Statements [3.iv]

The copyright holders each provide a statement of copyright in each source code file in resource_retriever_service.

Testing [4]

Feature Testing [4.i]

Each feature in resource_retriever_service has corresponding tests which simulate typical usage, and they are located in the test directory. New features are required to have tests before being added. Currently nightly test results can be seen here:

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. The tests aim to cover both typical usage and corner cases, but are quantified by contributing to code coverage.

Coverage [4.iii]

resource_retriever_service does not currently track code coverage statistics but attempts to ensure there are sufficient tests to provide confidence in the implementations.

Performance [4.iv]

resource_retriever_service follows the recommendations for performance testing of C code in the ROS 2 Developer Guide, and opts to do performance analysis on each release rather than each change. It is not yet defined if this package requires performance testing and how addresses this topic.

Linters and Static Analysis [4.v]

resource_retriever_service uses and passes all the ROS2 standard linters and static analysis tools for a C package as described in the ROS 2 Developer Guide. Passing implies there are no linter/static errors when testing against CI of supported platforms.

Currently nightly test results can be seen here:

Dependencies [5]

Direct Runtime ROS Dependencies [5.i]

There are several direct dependencies from the subpackages on external packages. They are listed below.

rclcpp [Level 2 Quality]
resource_retriever [Level unknown]

It has several “buildtool” and “test” dependencies, which do not affect the resulting quality of the package, because they do not contribute to the public library API.

Optional Direct Runtime ROS Dependencies [5.ii]

resource_retriever_service has no run-time or build-time dependencies that need to be considered for this declaration.

Direct Runtime non-ROS Dependency [5.iii]