Skip to content

QUALITY_DECLARATION.md

Latest commit

 

History

History
172 lines (92 loc) · 6.03 KB

QUALITY_DECLARATION.md

File metadata and controls

172 lines (92 loc) · 6.03 KB

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

rmf_building_sim_gz_classic_plugins Quality Declaration

The package rmf_building_sim_gz_classic_plugins 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 4 in REP-2004.

Version Policy [1]

Version Scheme [1.i]

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

Version Stability [1.ii]

rmf_building_sim_gz_classic_plugins 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_building_sim_gz_classic_plugins does not have a public API.

API Stability Policy [1.iv]

rmf_building_sim_gz_classic_plugins does not have a public API.

ABI Stability Policy [1.v]

rmf_building_sim_gz_classic_plugins does not have a public API.

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

rmf_building_sim_gz_classic_plugins does not have a public API.

Change Control Process [2]

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

Change Requests [2.i]

rmf_building_sim_gz_classic_plugins requires that all changes occur through a pull request.

Contributor Origin [2.ii]

rmf_building_sim_gz_classic_plugins 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_building_sim_gz_classic_plugins does not provide feature documentation.

Public API Documentation [3.ii]

rmf_building_sim_gz_classic_plugins does not have a public API.

License [3.iii]

The license for rmf_building_sim_gz_classic_plugins 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_tasks.

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_building_sim_gz_classic_plugins does not have any tests.

Public API Testing [4.ii]

rmf_building_sim_gz_classic_plugins does not have a public API.

Coverage [4.iii]

rmf_building_sim_gz_classic_plugins does not track coverage statistics.

Performance [4.iv]

rmf_building_sim_gz_classic_plugins does not have performance tests.

Linters and Static Analysis [4.v]

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

Dependencies [5]

Direct Runtime ROS Dependencies [5.i]

rmf_building_sim_gz_classic_plugins has the following direct runtime ROS dependencies.

rclcpp

rclcpp is Quality Level 1.

gazebo_dev

gazebo_dev does not declare a Quality Level. It is assumed to be at least Quality Level 4 based on its widespread use.

gazebo_ros

gazebo_ros does not declare a Quality Level. It is assumed to be at least Quality Level 4 based on its widespread use.

rmf_fleet_msgs

rmf_fleet_msgs is Quality Level 3.

rmf_building_sim_common

rmf_building_sim_common is Quality Level 4.

Optional Direct Runtime ROS Dependencies [5.ii]

rmf_building_sim_gz_classic_plugins does not have any optional direct runtime ROS dependencies.

Direct Runtime non-ROS Dependency [5.iii]

OpenCV

OpenCV does not declare a quality level. It is assumed to be Quality Level 1 based on wide-spread use.

menge_vendor

menge_vendor does not declare a quality level. It is assumed to be Quality Level 4.

qtbase5-dev

qt5base-dev is widely-used third-party software for building graphical applications. Due to its wide use, documentation, and testing, it is assumed to be Quality Level 3.

libqt5-widgets

libqt5-widgets is widely-used third-party software for building graphical applications. Due to its wide use, documentation, and testing, it is assumed to be Quality Level 3.

Platform Support [6]

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

Security [7]

Vulnerability Disclosure Policy [7.i]

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