This document is a declaration of software quality for the rosidl_runtime_c package, based on the guidelines in REP-2004.
The package rosidl_runtime_c claims to be in the Quality Level 1 category.
Below are the rationales, notes, and caveats for this claim, organized by each requirement listed in the Package Requirements for Quality Level 2 in REP-2004.
rosidl_runtime_c uses semver according to the recommendation for ROS Core packages in the ROS 2 Developer Guide.
rosidl_runtime_c 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.
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.
rosidl_runtime_c will not break public API within a released ROS distribution, i.e. no major releases once the ROS distribution is released.
rosidl_runtime_c contains C code and therefore must be concerned with ABI stability, and will maintain ABI stability within a ROS distribution.
rosidl_runtime_c follows the recommended guidelines for ROS Core packages in the ROS 2 Developer Guide.
This package requires that all changes occur through a pull request.
This package uses DCO as its confirmation of contributor origin policy. More information can be found in CONTRIBUTING.
Following the recommended guidelines for ROS Core packages, all pull request have at least 1 peer review.
All pull requests must pass CI on all tier 1 platforms.
Currently nightly results can be seen here:
All pull requests must resolve related documentation changes before merging.
rosidl_runtime_c has feature documentation and it is publicly hosted.
rosidl_runtime_c has documentation of its public API, hosted here.
The license for rosidl_runtime_c 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.
The copyright holders each provide a statement of copyright in each source code file in rosidl_runtime_c.
There is an automated test which runs a linter that ensures each file has at least one copyright statement.
Most recent test results can be found here
The features of rosidl_runtime_c are tested, and their tests are located in the test directory.
Most recent test results can be found here.
Most of the public API of rosidl_runtime_c is tested, and the tests are located in the test directory.
Most recent test results can be found here.
rosidl_runtime_c follows the recommendations for ROS Core packages in the ROS 2 Developer Guide, and opts to use line coverage instead of branch coverage.
This includes:
- tracking and reporting line coverage statistics
- achieving and maintaining a reasonable branch line coverage (90-100%)
- no lines are manually skipped in coverage calculations
Changes are required to make a best effort to keep or increase coverage before being accepted, but decreases are allowed if properly justified and accepted by reviewers.
Current coverage statistics can be viewed here. A description of how coverage statistics are summarized from this page, can be found in the ROS 2 Onboarding Guide.
Most of the features provided by this package are declarations of types and functions, and therefore do not require testing. The BoundedVector class is benchmarked and the most recent test results can be found here.
rosidl_runtime_c uses and passes all the standard linters and static analysis tools for a C package as described in the ROS 2 Developer Guide.
Results of the linting tests can be found here.
Below are evaluations of each of rosidl_runtime_c's run-time and build-time dependencies that have been determined to influence the quality.
It has "buildtool" dependencies, which do not affect the resulting quality of the package, because they do not contribute to the public library API. It also has several test dependencies, which do not affect the resulting quality of the package, because they are only used to build and run the test code.
The rosidl_typesupport_interface package provides several macros to define the rosidl C typesupport interface.
It is Quality Level 1, see its Quality Declaration document.
rosidl_runtime_c does not have any runtime non-ROS dependencies.
rosidl_runtime_c supports all of the tier 1 platforms as described in REP-2000, and tests each change against all of them.
Currently nightly results can be seen here:
This package conforms to the Vulnerability Disclosure Policy in REP-2006.