QUALITY_DECLARATION
This document is a declaration of software quality for the rmf_demo_panel
package, based on the guidelines in REP-2004.
rmf_demo_panel
Quality Declaration
The package rmf_demo_panel
claims to be in the Quality Level 4 category.
Below are the detailed rationales, notes, and caveats for this claim, organized by each requirement listed in the Package Requirements for Quality Level 3 in REP-2004.
Version Policy [1]
Version Scheme [1.i]
rmf_demo_panel
uses semver
according to the recommendation for ROS Core packages in the ROS 2 Developer Guide.
Version Stability [1.ii]
rmf_demo_panel
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]
rmf_demo_panel
does not have a public API.
API Stability Policy [1.iv]
rmf_demo_panel
does not have a public API.
ABI Stability Policy [1.v]
rmf_demo_panel
does not have a public API.
API and ABI Stability Within a Released ROS Distribution [1.vi]
rmf_demo_panel
does not have a public API.
Change Control Process [2]
rmf_demo_panel
follows the recommended guidelines for ROS Core packages in the ROS 2 Developer Guide.
Change Requests [2.i]
rmf_demo_panel
requires that all changes occur through a pull request.
Contributor Origin [2.ii]
rmf_demo_panel
uses DCO as its confirmation of contributor origin policy. More information can be found in CONTRIBUTING.
Peer Review Policy [2.iii]
All pull requests must have at least 1 peer review.
Continuous Integration [2.iv]
All pull requests must pass CI on all platforms supported by RMF. The CI checks only that the package builds. The most recent CI results can be seen on the workflow page.
Documentation Policy [2.v]
All pull requests must resolve related documentation changes before merging.
Documentation [3]
Feature Documentation [3.i]
rmf_demo_panel
is documented in the parent repository’s README.md file and in its own README.md file.
Public API Documentation [3.ii]
rmf_demo_panel
does not have a public API.
License [3.iii]
The license for rmf_demo_panel
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.
Copyright Statement [3.iv]
The copyright holders each provide a statement of copyright in each source code file in rmf_demo_panel
.
Quality declaration document [3.v]
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.
Testing [4]
Feature Testing [4.i]
rmf_demo_panel
does not have feature tests.
Public API Testing [4.ii]
rmf_demo_panel
does not have API tests.
Coverage [4.iii]
rmf_demo_panel
does not measure code coverage of tests.
Performance [4.iv]
rmf_demo_panel
does not test performance.
Linters and Static Analysis [4.v]
rmf_demo_panel
does not utilise linters or static analysis tools.
Dependencies [5]
Direct Runtime ROS Dependencies [5.i]
rmf_demo_panel
has the following direct runtime ROS dependencies.
rmf_fleet_msgs
rmf_fleet_msgs
is Quality Level 3.
rmf_task_msgs
rmf_task_msgs
is Quality Level 3.
rmf_demos_dashboard_resources
rmf_demos_dashboard_resources
is Quality Level 3.
Optional Direct Runtime ROS Dependencies [5.ii]
rmf_demo_panel
does not have any optional direct runtime ROS dependencies.
Direct Runtime non-ROS Dependency [5.iii]
rmf_demo_panel
has the following direct runtime non-ROS dependencies.
python3-flask
python3-flask
is assumed to be Quality Level 4.
python3-flask-cors
python3-flask-cors
is assumed to be Quality Level 4.
Platform Support [6]
rmf_demo_panel
supports all of the tier 1 platforms as described in REP-2000, but does not currently test each change against all of them.
Security [7]
Vulnerability Disclosure Policy [7.i]
This package conforms to the Vulnerability Disclosure Policy in REP-2006.