This document is a declaration of software quality for the libconsole-bridge-dev ROS external dependency, based on the guidelines in REP-2004.
The ROS external dependency libconsole-bridge-dev claims to be in the Quality Level 1 category.
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.
libconsole-bridge-dev uses semver according to the recommendation for ROS Core packages in the ROS 2 Developer Guide.
libconsole-bridge-dev is at a stable version, i.e. >= 1.0.0.
All symbols in the installed headers are considered part of the public API.
libconsole-bridge-dev is used as an upstream package within the ROS2 ecosystem and has been API/ABI stable for several years. If a breaking change is introduced, ROS2 distributions will pin to a specific major version.
libconsole-bridge-dev is used as an upstream package within the ROS2 ecosystem and has been API/ABI stable for several years. If a breaking change is introduced, ROS2 distributions will pin to a specific major version.
If a breaking change is introduced, ROS2 distributions will pin libconsole-bridge-dev to a specific major version.
libconsole-bridge-dev 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 info can be seen under the contributing file of this repository.
All pull requests will be peer-reviewed, check ROS 2 Developer Guide for additional information.
Pull requests must pass CI under Linux and Windows environments set in with AppVeyor and Travis-CI. Jobs are automatically trigered with each PR and the results shown in the Github repository.
Current test results are shown here:
Linux (Travis CI) Windows (Appveyor)
All pull requests must resolve related documentation changes before merging.
libconsole-bridge-dev lists its features in the README file of its GitHub repository, here. Also its wiki provides additional documentation over its usage.
All functions and classes in the public API of libconsole-bridge-dev include docblocks explaining their functionality or describing its usage.
The license for libconsole-bridge-dev is 3-Clause BSD, and a summary is in each source file and a full copy of the license is in the LICENSE file.
The copyright holders each provide a statement of copyright in each source code file in libconsole-bridge-dev.
New source files added to this library will require having a copyright statement.
libconsole-bridge-dev provides testing of its features under the test folder.
libconsole-bridge-dev includes public API 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. Currently, the complete API of the package is not fully tested.
Current test results are shown here:
Linux (Travis CI) Windows (Appveyor)
libconsole-bridge-dev provides coverage testing under its configured Travis-CI.
Current test results are shown here:
Linux Coverage results(codecov).
The performance tests of this package are located in the vendored library. The most recent test results can be found here.
libconsole-bridge-dev doe s not provide performance testing.
libconsole-bridge-dev is being tested with cppcheck and cpplint.
libconsole-bridge-dev has no run-time or build-time dependencies that need to be considered for this declaration.
libconsole-bridge-dev officially supports Ubuntu, Windows and MacOS systems. CI tests PRs with Ubuntu Trusty (Travis CI) and Windows Server 2019 (Appveyor).
This package conforms to the Vulnerability Disclosure Policy in REP-2006.