Skip to content

Latest commit

 

History

History
184 lines (97 loc) · 6.85 KB

QUALITY_DECLARATION.md

File metadata and controls

184 lines (97 loc) · 6.85 KB

This document is a declaration of software quality for the rmf_fleet_adapter package, based on the guidelines in REP-2004.

rmf_fleet_adapter Quality Declaration

The package rmf_fleet_adapter 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.

Version Policy [1]

Version Scheme [1.i]

rmf_fleet_adapter uses semver according to the recommendation for ROS Core packages in the ROS 2 Developer Guide.

Version Stability [1.ii]

rmf_fleet_adapter 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]

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.

API Stability Policy [1.iv]

rmf_fleet_adapter will not break public API within a major version number.

ABI Stability Policy [1.v]

rmf_fleet_adapter will not break public ABI within a major version number.

API and ABI Stability Within a Released ROS Distribution [1.vi]

rmf_fleet_adapter 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.

Change Control Process [2]

rmf_fleet_adapter follows the recommended guidelines for ROS Core packages in the ROS 2 Developer Guide.

Change Requests [2.i]

rmf_fleet_adapter requires that all changes occur through a pull request.

Contributor Origin [2.ii]

rmf_fleet_adapter 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 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_fleet_adapter does not provide documentation.

Public API Documentation [3.ii]

rmf_fleet_adapter documents its public API. The documentation is not hosted.

License [3.iii]

The license for rmf_fleet_adapter 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_fleet_adapter.

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]

Each feature in rmf_fleet_adapter has corresponding tests which simulate typical usage. They are located in the test directory. New features are required to have tests before being added.

Public API Testing [4.ii]

Each part of the public API has tests, and new additions or changes to the public API require tests before being added. The tests are not run automatically. They are located in the test directory.

Coverage [4.iii]

rmf_fleet_adapter does not track coverage statistics.

Performance [4.iv]

rmf_fleet_adapter does not test performance.

Linters and Static Analysis [4.v]

rmf_fleet_adapter does not use the standard linters and static analysis tools for its CMake code to ensure it follows the ROS 2 Developer Guide.

rmf_fleet_adapter uses a custom uncrustify configuration matching its coding style.

Dependencies [5]

Direct Runtime ROS Dependencies [5.i]

Below are the required direct runtime ROS dependencies of rmf_fleet_adapter and their evaluations.

rmf_utils

rmf_utils is Quality Level 4.

rmf_door_msgs

rmf_door_msgs is Quality Level 3.

rmf_ingestor_msgs

rmf_ingestor_msgs is Quality Level 3.

rmf_dispenser_msgs

rmf_dispenser_msgs is Quality Level 3.

rmf_fleet_msgs

rmf_fleet_msgs is Quality Level 3.

rmf_lift_msgs

rmf_lift_msgs is Quality Level 3.

rmf_task_msgs

rmf_task_msgs is Quality Level 3.

rmf_traffic

rmf_traffic is Quality Level 4.

rmf_traffic_ros2

rmf_traffic_ros2 is Quality Level 4.

Optional Direct Runtime ROS Dependencies [5.ii]

rmf_fleet_adapter has no optional runtime ROS dependencies.

Direct Runtime non-ROS Dependency [5.iii]

rmf_fleet_adapter uses the yaml-cpp library. This is assumed to be Quality Level 2 due to its wide use, provided documentation, use of testing, and version number above 1.0.0.

Platform Support [6]

Target platforms [6.i]

rmf_fleet_adapter does not support all of the tier 1 platforms as described in REP-2000. rmf_fleet_adapter supports ROS Foxy.

Security [7]

Vulnerability Disclosure Policy [7.i]

This package conforms to the Vulnerability Disclosure Policy in REP-2006.