This document is a declaration of software quality for the rcl_yaml_param_parser package, based on the guidelines in REP-2004.
The package rcl_yaml_param_parser 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 Quality Categories in REP-2004.
rcl_yaml_param_parser uses semver according to the recommendation for ROS Core packages in the ROS 2 Developer Guide.
rcl_yaml_param_parser 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.
rcl_yaml_param_parser will not break public API within a released ROS distribution, i.e. no major releases once the ROS distribution is released.
rcl_yaml_param_parser contains C and C++ code and therefore must be concerned with ABI stability, and will maintain ABI stability within a ROS distribution.
rcl_yaml_param_parser 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 requests must have at least 1 peer review.
All pull requests must pass CI on all tier 1 platforms.
All pull requests must resolve related documentation changes before merging.
rcl_yaml_param_parser provides the main elements of its API listed using doxygen and is hosted here.
rcl_yaml_param_parser has embedded API documentation and it is generated using doxygen. Currently, its latest version is hosted here. Latest version has to be generated before considering this item fully resolved.
All of rcl_yaml_param_parser has embedded API documentation. It is not yet hosted publicly.
The license for rcl_yaml_param_parser 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 most recent test results can be found here.
The copyright holders each provide a statement of copyright in each source code file in rcl_yaml_param_parser.
There is an automated test which runs a linter that ensures each file has at least one copyright statement.
The results of the test can be found here.
Most features in rcl_yaml_param_parser have 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:
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.
rcl_yaml_param_parser 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
- 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 calculated is summarized in this page "ROS 2 Onboarding Guide".
rcl_yaml_param_parser follows the recommendations for performance testing of C/C++ code in the ROS 2 Developer Guide, and opts to do performance analysis on each release rather than each change.
The performance tests of rcl_yaml_param_parser are located in the test/benchmark directory.
Package and system level performance benchmarks that cover features of rcl_yaml_param_parser can be found at:
Changes that introduce regressions in performance must be adequately justified in order to be accepted and merged.
rcl_yaml_param_parser 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 nightly linter tests can be found here.
Below are evaluations of each of rcl_yaml_param_parser's run-time and build-time dependencies that have been determined to influence the quality.
It has several "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.
rcutils provides commonly used functionality in C.
It is Quality Level 1, see its Quality Declaration document.
libyaml_vendor is a vendor package for the libyaml C library.
It is Quality Level 1, see its Quality Declaration document.
rcl_yaml_param_parser has the following runtime non-ROS dependencies.
libyaml is a YAML parsing library written in C.
It is Quality Level 1, see its Quality Declaration document.
rcl_yaml_param_parser 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.