This document is a declaration of software quality for the rmf_task package, based on the guidelines in REP-2004.
The package rmf_task 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.
rmf_task uses semver according to the recommendation for ROS Core packages in the ROS 2 Developer Guide.
rmf_task 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 are considered private.
All launch files in the installed launch directory are considered part of the public API.
rmf_task_sequence will not break public API within a major version number.
rmf_task_sequence will not break public ABI within a major version number.
rmf_task_sequence 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.
rmf_task_sequence follows the recommended guidelines for ROS Core packages in the ROS 2 Developer Guide.
rmf_task_sequence requires that all changes occur through a pull request.
rmf_task_sequence uses DCO as its confirmation of contributor origin policy.
More information can be found in CONTRIBUTING.
All pull requests must have at least 1 peer review.
All pull requests must pass CI on all platforms supported by RMF.
The most recent CI results can be seen on the workflow page.
All pull requests must resolve related documentation changes before merging.
rmf_task_sequence does not provide documentation.
rmf_task_sequence documents its public API.
The documentation is not hosted.
The license for rmf_task_sequence 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.
The copyright holders each provide a statement of copyright in each source code file in rmf_task_sequence.
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.
Each feature in rmf_task_sequence has corresponding tests which simulate typical usage.
They are located in the test directory.
New features are required to have tests before being added.
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.
rmf_task_sequence 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.
rmf_task_sequence does not test performance.
rmf_task_sequence does not use the standard linters and static analysis tools for its CMake code to ensure it follows the ROS 2 Developer Guide.
rmf_task_sequence uses a custom uncrustify configuration matching its coding style.
Below are the required direct runtime ROS dependencies of rmf_task_sequence and their evaluations.
rmf_task is Quality Level 4.
rmf_task_sequence has no optional runtime ROS dependencies.
rmf_task_sequence has no direct runtime non-ROS dependencies.
rmf_task_sequence does not support all of the tier 1 platforms as described in REP-2000.
rmf_task_sequence supports ROS Foxy.
This package conforms to the Vulnerability Disclosure Policy in REP-2006.