From 28695eb475b68a8c6892d4772ba0e80c8200e3e2 Mon Sep 17 00:00:00 2001 From: Geoffrey Biggs Date: Fri, 5 Mar 2021 10:20:46 +0900 Subject: [PATCH 1/6] Add quality declaration documents Signed-off-by: Geoffrey Biggs --- rmf_fleet_adapter/QUALITY_DECLARATION.md | 187 +++++++++++++++++++++++ rmf_fleet_adapter/README.md | 7 +- 2 files changed, 193 insertions(+), 1 deletion(-) create mode 100644 rmf_fleet_adapter/QUALITY_DECLARATION.md diff --git a/rmf_fleet_adapter/QUALITY_DECLARATION.md b/rmf_fleet_adapter/QUALITY_DECLARATION.md new file mode 100644 index 000000000..f48790556 --- /dev/null +++ b/rmf_fleet_adapter/QUALITY_DECLARATION.md @@ -0,0 +1,187 @@ +This document is a declaration of software quality for the `rmf_fleet_adapter` package, based on the guidelines in [REP-2004](https://www.ros.org/reps/rep-2004.html). + +# `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](https://www.ros.org/reps/rep-2004.html). + +## 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](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#versioning). + +### 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](package.xml), and its change history can be found in its [CHANGELOG](CHANGELOG.rst). + +### 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](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#package-requirements). + +### Change Requests [2.i] + +`rmf_fleet_adapter` requires that all changes occur through a pull request. + +### Contributor Origin [2.ii] + +`rmf_fleet_adapter` does not require a confirmation of contributor origin. + +### 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](https://github.com/open-rmf/rmf_core_ros2/actions). + +### 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](package.xml) manifest file, and a full copy of the license is in the repository level [LICENSE](../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](README.md). + +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`](https://github.com/open-rmf/rmf_core_ros2/tree/master/rmf_fleet_adapter/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`](https://github.com/open-rmf/rmf_core_ros2/tree/master/rmf_fleet_adapter/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](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#linters). + +`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**](https://github.com/open-rmf/rmf_utils/blob/master/rmf_core_utils/QUALITY_DECLARATION.md). + +#### rmf_door_msgs + +`rmf_door_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_door_msgs/QUALITY_DECLARATION.md). + +#### rmf_ingestor_msgs + +`rmf_ingestor_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_ingestor_msgs/QUALITY_DECLARATION.md). + +#### rmf_dispenser_msgs + +`rmf_dispenser_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_dispenser_msgs/QUALITY_DECLARATION.md). + +#### rmf_fleet_msgs + +`rmf_fleet_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_fleet_msgs/QUALITY_DECLARATION.md). + +#### rmf_lift_msgs + +`rmf_lift_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_lift_msgs/QUALITY_DECLARATION.md). + +#### rmf_task_msgs + +`rmf_task_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_task_msgs/QUALITY_DECLARATION.md). + +#### rmf_traffic + +`rmf_traffic` is [**Quality Level 4**](https://github.com/open-rmf/rmf_traffic/blob/master/rmf_traffic/QUALITY_DECLARATION.md). + +#### rmf_traffic_ros2 + +`rmf_traffic_ros2` is [**Quality Level 4**](https://github.com/open-rmf/rmf_core_ros2/blob/master/rmf_traffic_ros2/QUALITY_DECLARATION.md). + +#### rmf_traffic_msgs + +`rmf_traffic_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_traffic_msgs/QUALITY_DECLARATION.md). + + +### 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](https://github.com/jbeder/yaml-cpp). +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](https://www.ros.org/reps/rep-2000.html#support-tiers). +`rmf_fleet_adapter` supports ROS Eloquent. + +## Security [7] + +### Vulnerability Disclosure Policy [7.i] + +This package conforms to the Vulnerability Disclosure Policy in [REP-2006](https://www.ros.org/reps/rep-2006.html). diff --git a/rmf_fleet_adapter/README.md b/rmf_fleet_adapter/README.md index 95419cdb8..f58b94d25 100644 --- a/rmf_fleet_adapter/README.md +++ b/rmf_fleet_adapter/README.md @@ -1,3 +1,8 @@ # rmf\_fleet\_adapter package -This package contains the various fleet adapter nodes for different levels of control. Using specific messages from `rmf_fleet_msgs`, it communicates with proprietary fleet drivers and managers through ROS2. +This package contains the various fleet adapter nodes for different levels of control. +Using specific messages from `rmf_fleet_msgs`, it communicates with proprietary fleet drivers and managers through ROS 2. + +## Quality Declaration + +This package claims to be in the **Quality Level 4** category. See the [Quality Declaration](QUALITY_DECLARATION.md) for more details. From 51c76870395353c7adab7b16613474f2916f5d4d Mon Sep 17 00:00:00 2001 From: Geoffrey Biggs Date: Fri, 5 Mar 2021 10:26:08 +0900 Subject: [PATCH 2/6] Add quality declaration documents Signed-off-by: Geoffrey Biggs --- rmf_task_ros2/QUALITY_DECLARATION.md | 169 ++++++++++++++++++++++++ rmf_task_ros2/README.md | 7 + rmf_traffic_ros2/QUALITY_DECLARATION.md | 169 ++++++++++++++++++++++++ rmf_traffic_ros2/README.md | 7 + 4 files changed, 352 insertions(+) create mode 100644 rmf_task_ros2/QUALITY_DECLARATION.md create mode 100644 rmf_task_ros2/README.md create mode 100644 rmf_traffic_ros2/QUALITY_DECLARATION.md create mode 100644 rmf_traffic_ros2/README.md diff --git a/rmf_task_ros2/QUALITY_DECLARATION.md b/rmf_task_ros2/QUALITY_DECLARATION.md new file mode 100644 index 000000000..3be03f0c8 --- /dev/null +++ b/rmf_task_ros2/QUALITY_DECLARATION.md @@ -0,0 +1,169 @@ +This document is a declaration of software quality for the `rmf_task_ros2` package, based on the guidelines in [REP-2004](https://www.ros.org/reps/rep-2004.html). + +# `rmf_task_ros2` Quality Declaration + +The package `rmf_task_ros2` 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](https://www.ros.org/reps/rep-2004.html). + +## Version Policy [1] + +### Version Scheme [1.i] + +`rmf_task_ros2` uses `semver` according to the recommendation for ROS Core packages in the [ROS 2 Developer Guide](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#versioning). + +### Version Stability [1.ii] + +`rmf_task_ros2` is at a stable version, i.e. `>= 1.0.0`. +The current version can be found in its [package.xml](package.xml), and its change history can be found in its [CHANGELOG](CHANGELOG.rst). + +### 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_task_ros2` will not break public API within a major version number. + +### ABI Stability Policy [1.v] + +`rmf_task_ros2` will not break public ABI within a major version number. + +### API and ABI Stability Within a Released ROS Distribution [1.vi] + +`rmf_task_ros2` 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_task_ros2` follows the recommended guidelines for ROS Core packages in the [ROS 2 Developer Guide](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#package-requirements). + +### Change Requests [2.i] + +`rmf_task_ros2` requires that all changes occur through a pull request. + +### Contributor Origin [2.ii] + +`rmf_task_ros2` does not require a confirmation of contributor origin. + +### 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](https://github.com/open-rmf/rmf_core_ros2/actions). + +### Documentation Policy [2.v] + +All pull requests must resolve related documentation changes before merging. + +## Documentation [3] + +### Feature Documentation [3.i] + +`rmf_task_ros2` does not provide documentation. + +### Public API Documentation [3.ii] + +`rmf_task_ros2` documents its public API. +The documentation is not hosted. + +### License [3.iii] + +The license for `rmf_task_ros2` is Apache 2.0, the type is declared in the [package.xml](package.xml) manifest file, and a full copy of the license is in the repository level [LICENSE](../LICENSE) file. + +### Copyright Statement [3.iv] + +The copyright holders each provide a statement of copyright in each source code file in `rmf_task_ros2`. + +### Quality declaration document [3.v] + +This quality declaration is linked in the [README file](README.md). + +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_task_ros2` has corresponding tests which simulate typical usage. +They are located in the [`test`](https://github.com/open-rmf/rmf_core_ros2/tree/master/rmf_task_ros2/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`](https://github.com/open-rmf/rmf_core_ros2/tree/master/rmf_task_ros2/test) directory. + +### Coverage [4.iii] + +`rmf_task_ros2` does not track coverage statistics. + +### Performance [4.iv] + +`rmf_task_ros2` does not test performance. + +### Linters and Static Analysis [4.v] + +`rmf_task_ros2` does not use the standard linters and static analysis tools for its CMake code to ensure it follows the [ROS 2 Developer Guide](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#linters). + +`rmf_task_ros2` 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_task_ros2` and their evaluations. + +#### rmf\_utils + +`rmf_utils` is [**Quality Level 4**](https://github.com/open-rmf/rmf_utils/blob/master/rmf_core_utils/QUALITY_DECLARATION.md). + +#### rmf\_traffic + +`rmf_traffic` is [**Quality Level 4**](https://github.com/open-rmf/rmf_traffic/blob/master/rmf_traffic/QUALITY_DECLARATION.md). + +#### rmf\_traffic\_ros2 + +`rmf_traffic_ros2` is [**Quality Level 4**](https://github.com/open-rmf/rmf_core_ros2/blob/master/rmf_traffic_ros2/QUALITY_DECLARATION.md). + +#### rmf\_task\_msgs + +`rmf_task_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_task_msgs/QUALITY_DECLARATION.md). + +#### rclcpp + +`rclcpp` is [**Quality Level 3**](https://github.com/ros2/rclcpp/blob/master/rclcpp/QUALITY_DECLARATION.md). + +### Optional Direct Runtime ROS Dependencies [5.ii] + +`rmf_task_ros2` has no optional runtime ROS dependencies. + +### Direct Runtime non-ROS Dependency [5.iii] + +`rmf_task_ros2` has the following direct runtime non-ROS dependencies. + +#### eigen + +`eigen` is taken to be **Quality Level 3** due to its wide-spread use, history, use of CI, and use of testing. + +## Platform Support [6] + +### Target platforms [6.i] + +`rmf_task_ros2` does not support all of the tier 1 platforms as described in [REP-2000](https://www.ros.org/reps/rep-2000.html#support-tiers). +`rmf_task_ros2` supports ROS Eloquent. + +## Security [7] + +### Vulnerability Disclosure Policy [7.i] + +This package conforms to the Vulnerability Disclosure Policy in [REP-2006](https://www.ros.org/reps/rep-2006.html). diff --git a/rmf_task_ros2/README.md b/rmf_task_ros2/README.md new file mode 100644 index 000000000..8a9210c5b --- /dev/null +++ b/rmf_task_ros2/README.md @@ -0,0 +1,7 @@ +# rmf\_task\_ros2 package + +This package provides interfaces between `rmf_task` and ROS 2 interfaces. + +## Quality Declaration + +This package claims to be in the **Quality Level 4** category. See the [Quality Declaration](QUALITY_DECLARATION.md) for more details. diff --git a/rmf_traffic_ros2/QUALITY_DECLARATION.md b/rmf_traffic_ros2/QUALITY_DECLARATION.md new file mode 100644 index 000000000..59abe4a6c --- /dev/null +++ b/rmf_traffic_ros2/QUALITY_DECLARATION.md @@ -0,0 +1,169 @@ +This document is a declaration of software quality for the `rmf_traffic_ros2` package, based on the guidelines in [REP-2004](https://www.ros.org/reps/rep-2004.html). + +# `rmf_traffic_ros2` Quality Declaration + +The package `rmf_traffic_ros2` 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](https://www.ros.org/reps/rep-2004.html). + +## Version Policy [1] + +### Version Scheme [1.i] + +`rmf_traffic_ros2` uses `semver` according to the recommendation for ROS Core packages in the [ROS 2 Developer Guide](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#versioning). + +### Version Stability [1.ii] + +`rmf_traffic_ros2` is at a stable version, i.e. `>= 1.0.0`. +The current version can be found in its [package.xml](package.xml), and its change history can be found in its [CHANGELOG](CHANGELOG.rst). + +### 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_traffic_ros2` will not break public API within a major version number. + +### ABI Stability Policy [1.v] + +`rmf_traffic_ros2` will not break public ABI within a major version number. + +### API and ABI Stability Within a Released ROS Distribution [1.vi] + +`rmf_traffic_ros2` 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_traffic_ros2` follows the recommended guidelines for ROS Core packages in the [ROS 2 Developer Guide](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#package-requirements). + +### Change Requests [2.i] + +`rmf_traffic_ros2` requires that all changes occur through a pull request. + +### Contributor Origin [2.ii] + +`rmf_traffic_ros2` does not require a confirmation of contributor origin. + +### 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](https://github.com/open-rmf/rmf_core_ros2/actions). + +### Documentation Policy [2.v] + +All pull requests must resolve related documentation changes before merging. + +## Documentation [3] + +### Feature Documentation [3.i] + +`rmf_traffic_ros2` does not provide documentation. + +### Public API Documentation [3.ii] + +`rmf_traffic_ros2` documents its public API. +The documentation is not hosted. + +### License [3.iii] + +The license for `rmf_traffic_ros2` is Apache 2.0, the type is declared in the [package.xml](package.xml) manifest file, and a full copy of the license is in the repository level [LICENSE](../LICENSE) file. + +### Copyright Statement [3.iv] + +The copyright holders each provide a statement of copyright in each source code file in `rmf_traffic_ros2`. + +### Quality declaration document [3.v] + +This quality declaration is linked in the [README file](README.md). + +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_traffic_ros2` has corresponding tests which simulate typical usage. +They are located in the [`test`](https://github.com/open-rmf/rmf_core_ros2/tree/master/rmf_traffic_ros2/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`](https://github.com/open-rmf/rmf_core_ros2/tree/master/rmf_traffic_ros2/test) directory. + +### Coverage [4.iii] + +`rmf_traffic_ros2` does not track coverage statistics. + +### Performance [4.iv] + +`rmf_traffic_ros2` does not test performance. + +### Linters and Static Analysis [4.v] + +`rmf_traffic_ros2` does not use the standard linters and static analysis tools for its CMake code to ensure it follows the [ROS 2 Developer Guide](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#linters). + +`rmf_traffic_ros2` 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_traffic_ros2` and their evaluations. + +#### rmf\_utils + +`rmf_utils` is [**Quality Level 4**](https://github.com/open-rmf/rmf_utils/blob/master/rmf_core_utils/QUALITY_DECLARATION.md). + +#### rmf\_fleet\_msgs + +`rmf_fleet_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_fleet_msgs/QUALITY_DECLARATION.md). + +#### rmf\_traffic + +`rmf_traffic` is [**Quality Level 4**](https://github.com/open-rmf/rmf_traffic/blob/master/rmf_traffic/QUALITY_DECLARATION.md). + +#### rmf\_traffic\_msgs + +`rmf_traffic_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_traffic_msgs/QUALITY_DECLARATION.md). + +#### rclcpp + +`rclcpp` is [**Quality Level 3**](https://github.com/ros2/rclcpp/blob/master/rclcpp/QUALITY_DECLARATION.md). + +### Optional Direct Runtime ROS Dependencies [5.ii] + +`rmf_traffic_ros2` has no optional runtime ROS dependencies. + +### Direct Runtime non-ROS Dependency [5.iii] + +`rmf_traffic_ros2` has the following direct runtime non-ROS dependencies. + +#### eigen + +`eigen` is taken to be **Quality Level 3** due to its wide-spread use, history, use of CI, and use of testing. + +## Platform Support [6] + +### Target platforms [6.i] + +`rmf_traffic_ros2` does not support all of the tier 1 platforms as described in [REP-2000](https://www.ros.org/reps/rep-2000.html#support-tiers). +`rmf_traffic_ros2` supports ROS Eloquent. + +## Security [7] + +### Vulnerability Disclosure Policy [7.i] + +This package conforms to the Vulnerability Disclosure Policy in [REP-2006](https://www.ros.org/reps/rep-2006.html). diff --git a/rmf_traffic_ros2/README.md b/rmf_traffic_ros2/README.md new file mode 100644 index 000000000..64ad21111 --- /dev/null +++ b/rmf_traffic_ros2/README.md @@ -0,0 +1,7 @@ +# rmf\_traffic\_ros2 package + +This package provides interfaces between `rmf_traffic` and ROS 2 interfaces. + +## Quality Declaration + +This package claims to be in the **Quality Level 4** category. See the [Quality Declaration](QUALITY_DECLARATION.md) for more details. From a04b58d2ad1c57673c4f72255695c07412f7e920 Mon Sep 17 00:00:00 2001 From: "Michael X. Grey" Date: Thu, 22 Apr 2021 23:17:47 +0800 Subject: [PATCH 3/6] Updating quality declarations Signed-off-by: Michael X. Grey --- CONTRIBUTING.md | 18 ++++++++++++++ rmf_fleet_adapter/QUALITY_DECLARATION.md | 30 ++++++++++++------------ rmf_task_ros2/QUALITY_DECLARATION.md | 20 ++++++++-------- rmf_traffic_ros2/QUALITY_DECLARATION.md | 20 ++++++++-------- 4 files changed, 53 insertions(+), 35 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..cfba094da --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +Any contribution that you make to this repository will +be under the Apache 2 License, as dictated by that +[license](http://www.apache.org/licenses/LICENSE-2.0.html): + +~~~ +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. +~~~ + +Contributors must sign-off each commit by adding a `Signed-off-by: ...` +line to commit messages to certify that they have the right to submit +the code they are contributing to the project according to the +[Developer Certificate of Origin (DCO)](https://developercertificate.org/). diff --git a/rmf_fleet_adapter/QUALITY_DECLARATION.md b/rmf_fleet_adapter/QUALITY_DECLARATION.md index f48790556..c41326544 100644 --- a/rmf_fleet_adapter/QUALITY_DECLARATION.md +++ b/rmf_fleet_adapter/QUALITY_DECLARATION.md @@ -48,7 +48,7 @@ All launch files in the installed `launch` directory are considered part of the ### Contributor Origin [2.ii] -`rmf_fleet_adapter` does not require a confirmation of contributor origin. +`rmf_fleet_adapter` uses DCO as its confirmation of contributor origin policy. More information can be found in [CONTRIBUTING](../CONTRIBUTING.md). ### Peer Review Policy [2.iii] @@ -58,7 +58,7 @@ 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](https://github.com/open-rmf/rmf_core_ros2/actions). +The most recent CI results can be seen on [the workflow page](https://github.com/open-rmf/rmf_ros2/actions). ### Documentation Policy [2.v] @@ -94,14 +94,14 @@ This quality declaration has not been externally peer-reviewed and is not regist ### Feature Testing [4.i] Each feature in `rmf_fleet_adapter` has corresponding tests which simulate typical usage. -They are located in the [`test`](https://github.com/open-rmf/rmf_core_ros2/tree/master/rmf_fleet_adapter/test) directory. +They are located in the [`test`](https://github.com/open-rmf/rmf_ros2/tree/master/rmf_fleet_adapter/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`](https://github.com/open-rmf/rmf_core_ros2/tree/master/rmf_fleet_adapter/test) directory. +They are located in the [`test`](https://github.com/open-rmf/rmf_ros2/tree/master/rmf_fleet_adapter/test) directory. ### Coverage [4.iii] @@ -125,43 +125,43 @@ Below are the required direct runtime ROS dependencies of `rmf_fleet_adapter` an #### rmf_utils -`rmf_utils` is [**Quality Level 4**](https://github.com/open-rmf/rmf_utils/blob/master/rmf_core_utils/QUALITY_DECLARATION.md). +`rmf_utils` is [**Quality Level 4**](https://github.com/open-rmf/rmf_utils/blob/main/rmf_utils/QUALITY_DECLARATION.md). #### rmf_door_msgs -`rmf_door_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_door_msgs/QUALITY_DECLARATION.md). +`rmf_door_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_internal_msgs/blob/main/rmf_door_msgs/QUALITY_DECLARATION.md). #### rmf_ingestor_msgs -`rmf_ingestor_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_ingestor_msgs/QUALITY_DECLARATION.md). +`rmf_ingestor_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_internal_msgs/blob/main/rmf_ingestor_msgs/QUALITY_DECLARATION.md). #### rmf_dispenser_msgs -`rmf_dispenser_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_dispenser_msgs/QUALITY_DECLARATION.md). +`rmf_dispenser_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_internal_msgs/blob/main/rmf_dispenser_msgs/QUALITY_DECLARATION.md). #### rmf_fleet_msgs -`rmf_fleet_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_fleet_msgs/QUALITY_DECLARATION.md). +`rmf_fleet_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_internal_msgs/blob/main/rmf_fleet_msgs/QUALITY_DECLARATION.md). #### rmf_lift_msgs -`rmf_lift_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_lift_msgs/QUALITY_DECLARATION.md). +`rmf_lift_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_internal_msgs/blob/main/rmf_lift_msgs/QUALITY_DECLARATION.md). #### rmf_task_msgs -`rmf_task_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_task_msgs/QUALITY_DECLARATION.md). +`rmf_task_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_internal_msgs/blob/main/rmf_task_msgs/QUALITY_DECLARATION.md). #### rmf_traffic -`rmf_traffic` is [**Quality Level 4**](https://github.com/open-rmf/rmf_traffic/blob/master/rmf_traffic/QUALITY_DECLARATION.md). +`rmf_traffic` is [**Quality Level 4**](https://github.com/open-rmf/rmf_traffic/blob/main/rmf_traffic/QUALITY_DECLARATION.md). #### rmf_traffic_ros2 -`rmf_traffic_ros2` is [**Quality Level 4**](https://github.com/open-rmf/rmf_core_ros2/blob/master/rmf_traffic_ros2/QUALITY_DECLARATION.md). +`rmf_traffic_ros2` is [**Quality Level 4**](https://github.com/open-rmf/rmf_ros2/blob/main/rmf_traffic_ros2/QUALITY_DECLARATION.md). #### rmf_traffic_msgs -`rmf_traffic_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_traffic_msgs/QUALITY_DECLARATION.md). +`rmf_traffic_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_internal_msgs/blob/main/rmf_traffic_msgs/QUALITY_DECLARATION.md). ### Optional Direct Runtime ROS Dependencies [5.ii] @@ -178,7 +178,7 @@ This is assumed to be **Quality Level 2** due to its wide use, provided document ### Target platforms [6.i] `rmf_fleet_adapter` does not support all of the tier 1 platforms as described in [REP-2000](https://www.ros.org/reps/rep-2000.html#support-tiers). -`rmf_fleet_adapter` supports ROS Eloquent. +`rmf_fleet_adapter` supports ROS Foxy. ## Security [7] diff --git a/rmf_task_ros2/QUALITY_DECLARATION.md b/rmf_task_ros2/QUALITY_DECLARATION.md index 3be03f0c8..d2ef5a3c8 100644 --- a/rmf_task_ros2/QUALITY_DECLARATION.md +++ b/rmf_task_ros2/QUALITY_DECLARATION.md @@ -48,7 +48,7 @@ All launch files in the installed `launch` directory are considered part of the ### Contributor Origin [2.ii] -`rmf_task_ros2` does not require a confirmation of contributor origin. +`rmf_task_ros2` uses DCO as its confirmation of contributor origin policy. More information can be found in [CONTRIBUTING](../CONTRIBUTING.md). ### Peer Review Policy [2.iii] @@ -58,7 +58,7 @@ 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](https://github.com/open-rmf/rmf_core_ros2/actions). +The most recent CI results can be seen on [the workflow page](https://github.com/open-rmf/rmf_ros2/actions). ### Documentation Policy [2.v] @@ -94,14 +94,14 @@ This quality declaration has not been externally peer-reviewed and is not regist ### Feature Testing [4.i] Each feature in `rmf_task_ros2` has corresponding tests which simulate typical usage. -They are located in the [`test`](https://github.com/open-rmf/rmf_core_ros2/tree/master/rmf_task_ros2/test) directory. +They are located in the [`test`](https://github.com/open-rmf/rmf_ros2/tree/main/rmf_task_ros2/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`](https://github.com/open-rmf/rmf_core_ros2/tree/master/rmf_task_ros2/test) directory. +They are located in the [`test`](https://github.com/open-rmf/rmf_ros2/tree/main/rmf_task_ros2/test) directory. ### Coverage [4.iii] @@ -125,23 +125,23 @@ Below are the required direct runtime ROS dependencies of `rmf_task_ros2` and th #### rmf\_utils -`rmf_utils` is [**Quality Level 4**](https://github.com/open-rmf/rmf_utils/blob/master/rmf_core_utils/QUALITY_DECLARATION.md). +`rmf_utils` is [**Quality Level 4**](https://github.com/open-rmf/rmf_utils/blob/main/rmf_utils/QUALITY_DECLARATION.md). #### rmf\_traffic -`rmf_traffic` is [**Quality Level 4**](https://github.com/open-rmf/rmf_traffic/blob/master/rmf_traffic/QUALITY_DECLARATION.md). +`rmf_traffic` is [**Quality Level 4**](https://github.com/open-rmf/rmf_traffic/blob/main/rmf_traffic/QUALITY_DECLARATION.md). #### rmf\_traffic\_ros2 -`rmf_traffic_ros2` is [**Quality Level 4**](https://github.com/open-rmf/rmf_core_ros2/blob/master/rmf_traffic_ros2/QUALITY_DECLARATION.md). +`rmf_traffic_ros2` is [**Quality Level 4**](https://github.com/open-rmf/rmf_ros2/blob/main/rmf_traffic_ros2/QUALITY_DECLARATION.md). #### rmf\_task\_msgs -`rmf_task_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_task_msgs/QUALITY_DECLARATION.md). +`rmf_task_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_internal_msgs/blob/main/rmf_task_msgs/QUALITY_DECLARATION.md). #### rclcpp -`rclcpp` is [**Quality Level 3**](https://github.com/ros2/rclcpp/blob/master/rclcpp/QUALITY_DECLARATION.md). +`rclcpp` is [**Quality Level 1**](https://github.com/ros2/rclcpp/blob/main/rclcpp/QUALITY_DECLARATION.md). ### Optional Direct Runtime ROS Dependencies [5.ii] @@ -160,7 +160,7 @@ Below are the required direct runtime ROS dependencies of `rmf_task_ros2` and th ### Target platforms [6.i] `rmf_task_ros2` does not support all of the tier 1 platforms as described in [REP-2000](https://www.ros.org/reps/rep-2000.html#support-tiers). -`rmf_task_ros2` supports ROS Eloquent. +`rmf_task_ros2` supports ROS Foxy. ## Security [7] diff --git a/rmf_traffic_ros2/QUALITY_DECLARATION.md b/rmf_traffic_ros2/QUALITY_DECLARATION.md index 59abe4a6c..0b1c7b408 100644 --- a/rmf_traffic_ros2/QUALITY_DECLARATION.md +++ b/rmf_traffic_ros2/QUALITY_DECLARATION.md @@ -48,7 +48,7 @@ All launch files in the installed `launch` directory are considered part of the ### Contributor Origin [2.ii] -`rmf_traffic_ros2` does not require a confirmation of contributor origin. +`rmf_traffic_ros2` uses DCO as its confirmation of contributor origin policy. More information can be found in [CONTRIBUTING](../CONTRIBUTING.md). ### Peer Review Policy [2.iii] @@ -58,7 +58,7 @@ 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](https://github.com/open-rmf/rmf_core_ros2/actions). +The most recent CI results can be seen on [the workflow page](https://github.com/open-rmf/rmf_ros2/actions). ### Documentation Policy [2.v] @@ -94,14 +94,14 @@ This quality declaration has not been externally peer-reviewed and is not regist ### Feature Testing [4.i] Each feature in `rmf_traffic_ros2` has corresponding tests which simulate typical usage. -They are located in the [`test`](https://github.com/open-rmf/rmf_core_ros2/tree/master/rmf_traffic_ros2/test) directory. +They are located in the [`test`](https://github.com/open-rmf/rmf_ros2/tree/main/rmf_traffic_ros2/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`](https://github.com/open-rmf/rmf_core_ros2/tree/master/rmf_traffic_ros2/test) directory. +They are located in the [`test`](https://github.com/open-rmf/rmf_ros2/tree/main/rmf_traffic_ros2/test) directory. ### Coverage [4.iii] @@ -125,23 +125,23 @@ Below are the required direct runtime ROS dependencies of `rmf_traffic_ros2` and #### rmf\_utils -`rmf_utils` is [**Quality Level 4**](https://github.com/open-rmf/rmf_utils/blob/master/rmf_core_utils/QUALITY_DECLARATION.md). +`rmf_utils` is [**Quality Level 4**](https://github.com/open-rmf/rmf_utils/blob/main/rmf_utils/QUALITY_DECLARATION.md). #### rmf\_fleet\_msgs -`rmf_fleet_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_fleet_msgs/QUALITY_DECLARATION.md). +`rmf_fleet_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_internal_msgs/blob/main/rmf_fleet_msgs/QUALITY_DECLARATION.md). #### rmf\_traffic -`rmf_traffic` is [**Quality Level 4**](https://github.com/open-rmf/rmf_traffic/blob/master/rmf_traffic/QUALITY_DECLARATION.md). +`rmf_traffic` is [**Quality Level 4**](https://github.com/open-rmf/rmf_traffic/blob/main/rmf_traffic/QUALITY_DECLARATION.md). #### rmf\_traffic\_msgs -`rmf_traffic_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_core_msgs/blob/master/rmf_traffic_msgs/QUALITY_DECLARATION.md). +`rmf_traffic_msgs` is [**Quality Level 3**](https://github.com/open-rmf/rmf_internal_msgs/blob/main/rmf_traffic_msgs/QUALITY_DECLARATION.md). #### rclcpp -`rclcpp` is [**Quality Level 3**](https://github.com/ros2/rclcpp/blob/master/rclcpp/QUALITY_DECLARATION.md). +`rclcpp` is [**Quality Level 1**](https://github.com/ros2/rclcpp/blob/master/rclcpp/QUALITY_DECLARATION.md). ### Optional Direct Runtime ROS Dependencies [5.ii] @@ -160,7 +160,7 @@ Below are the required direct runtime ROS dependencies of `rmf_traffic_ros2` and ### Target platforms [6.i] `rmf_traffic_ros2` does not support all of the tier 1 platforms as described in [REP-2000](https://www.ros.org/reps/rep-2000.html#support-tiers). -`rmf_traffic_ros2` supports ROS Eloquent. +`rmf_traffic_ros2` supports ROS Foxy. ## Security [7] From 766c695914749238d7b51b2739a8d5178782815e Mon Sep 17 00:00:00 2001 From: Geoffrey Biggs Date: Tue, 27 Apr 2021 09:15:46 +0900 Subject: [PATCH 4/6] Update rmf_fleet_adapter/QUALITY_DECLARATION.md Signed-off-by: Geoffrey Biggs --- rmf_fleet_adapter/QUALITY_DECLARATION.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/rmf_fleet_adapter/QUALITY_DECLARATION.md b/rmf_fleet_adapter/QUALITY_DECLARATION.md index c41326544..18f984a97 100644 --- a/rmf_fleet_adapter/QUALITY_DECLARATION.md +++ b/rmf_fleet_adapter/QUALITY_DECLARATION.md @@ -48,7 +48,8 @@ All launch files in the installed `launch` directory are considered part of the ### Contributor Origin [2.ii] -`rmf_fleet_adapter` uses DCO as its confirmation of contributor origin policy. More information can be found in [CONTRIBUTING](../CONTRIBUTING.md). +`rmf_fleet_adapter` uses DCO as its confirmation of contributor origin policy. +More information can be found in [CONTRIBUTING](../CONTRIBUTING.md). ### Peer Review Policy [2.iii] From 3edfe7544e250df359077318a0556e56d5dd42fb Mon Sep 17 00:00:00 2001 From: Geoffrey Biggs Date: Tue, 27 Apr 2021 09:15:51 +0900 Subject: [PATCH 5/6] Update rmf_traffic_ros2/QUALITY_DECLARATION.md Signed-off-by: Geoffrey Biggs --- rmf_traffic_ros2/QUALITY_DECLARATION.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/rmf_traffic_ros2/QUALITY_DECLARATION.md b/rmf_traffic_ros2/QUALITY_DECLARATION.md index 0b1c7b408..8ef2c53a5 100644 --- a/rmf_traffic_ros2/QUALITY_DECLARATION.md +++ b/rmf_traffic_ros2/QUALITY_DECLARATION.md @@ -48,7 +48,8 @@ All launch files in the installed `launch` directory are considered part of the ### Contributor Origin [2.ii] -`rmf_traffic_ros2` uses DCO as its confirmation of contributor origin policy. More information can be found in [CONTRIBUTING](../CONTRIBUTING.md). +`rmf_traffic_ros2` uses DCO as its confirmation of contributor origin policy. +More information can be found in [CONTRIBUTING](../CONTRIBUTING.md). ### Peer Review Policy [2.iii] From eddf4840b3381c4d8761f0f30cf108b5c1690578 Mon Sep 17 00:00:00 2001 From: Geoffrey Biggs Date: Tue, 27 Apr 2021 09:15:56 +0900 Subject: [PATCH 6/6] Update rmf_task_ros2/QUALITY_DECLARATION.md Signed-off-by: Geoffrey Biggs --- rmf_task_ros2/QUALITY_DECLARATION.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/rmf_task_ros2/QUALITY_DECLARATION.md b/rmf_task_ros2/QUALITY_DECLARATION.md index d2ef5a3c8..c69515cac 100644 --- a/rmf_task_ros2/QUALITY_DECLARATION.md +++ b/rmf_task_ros2/QUALITY_DECLARATION.md @@ -48,7 +48,8 @@ All launch files in the installed `launch` directory are considered part of the ### Contributor Origin [2.ii] -`rmf_task_ros2` uses DCO as its confirmation of contributor origin policy. More information can be found in [CONTRIBUTING](../CONTRIBUTING.md). +`rmf_task_ros2` uses DCO as its confirmation of contributor origin policy. +More information can be found in [CONTRIBUTING](../CONTRIBUTING.md). ### Peer Review Policy [2.iii]