This document is a declaration of software quality for the libstatistics_collector package, based on the guidelines in REP-2004.
The package libstatistics_collector claims to be in the Quality Level 1 category when it is used with a Quality Level 1 middleware.
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.
libstatistics_collector uses semver according to the recommendation for ROS Core packages in the ROS 2 Developer Guide.
libstatistics_collector is at a stable version (>= 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.
libstatistics_collector follows semver versioning semantics and will not make changes to its API without increasing its major version number.
libstatistics_collector contains C and C++ code and is therefore concerned with ABI stability and will not change its ABI without increasing its major version number.
libstatistics_collector will not break API nor ABI within a released ROS distribution, i.e. no major releases once the ROS distribution is released.
libstatistics_collector follows the recommended guidelines for ROS Core packages in the ROS 2 Developer Guide.
All changes will occur through a pull request, check ROS 2 Developer Guide for additional information.
This package uses DCO as its confirmation of contributor origin policy. More information can be found in CONTRIBUTING.
All pull requests will be peer-reviewed, check ROS 2 Developer Guide for additional information.
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.
libstatistics_collector has a feature list and each item in the list links to the corresponding feature documentation. There is documentation for all of the features, and new features require documentation before being added.
The API documentation is not publicly available yet.
The license for libstatistics_collector 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.
The copyright holders each provide a statement of copyright in each source code file in libstatistics_collector.
There is an automated test which runs a linter that ensures each file has at least one copyright statement. Latest linter result report can be seen here.
Each feature in libstatistics_collector 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:
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.
libstatistics_collector 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.
Each time that a new PR is created codecov will create diagram to show the current status of the test coverage and how this PR will affect the coverage of the package. Latest codecov result report can be seen here.
libstatistics_collector 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 this package are located in the test/benchmark directory.
Package and system level performance benchmarks that cover features of libstatistics_collector can be found at:
Changes that introduce regressions in performance must be adequately justified in order to be accepted and merged.
libstatistics_collector 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:
libstatistics_collector has the following runtime ROS dependencies:
The rcl package supports implementation of language specific ROS Client Libraries.
It is Quality Level 1, see its Quality Declaration document.
The rcpputils package is a C++ API consisting of macros, functions, and data structures intended for use throughout the ROS 2 codebase.
It is Quality Level 1, see its Quality Declaration document.
The rosidl_default_runtime provides CMake functionality for finding and adding runtime dependencies for rosidl packages.
It is Quality Level 1, see its Quality Declaration document.
The statistics_msgs package contains ROS 2 message definitions for reporting statistics for topics and system resources.
It is Quality Level 1, see its Quality Declaration document.
The std_msgs package provides many basic message types.
It is Quality Level 1, see its Quality Declaration document.
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.
libstatistics_collector has no non-ROS runtime or build-time dependencies that need to be considered for this declaration.
libstatistics_collector supports all of the tier 1 platforms as described in REP-2000, and tests each change against all of them.
Currently nightly build status can be seen here:
This package conforms to the Vulnerability Disclosure Policy in REP-2006.