-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add QUALITY_DECLARATION for all but test_msgs
Signed-off-by: Stephen Brawner <brawner@gmail.com>
- Loading branch information
Showing
12 changed files
with
449 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
This document is a declaration of software quality for the `action_msgs` package, based on the guidelines in [REP-2004](https://www.ros.org/reps/rep-2004.html). | ||
|
||
# `action_msgs` Quality Declaration | ||
|
||
The package `action_msgs` 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 Requirements for Quality Level 1 in REP-2004](https://www.ros.org/reps/rep-2004.html). | ||
|
||
## Version Policy | ||
|
||
### Version Scheme | ||
|
||
`action_msgs` 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), and is at or above a stable version, i.e. `>= 1.0.0`. | ||
|
||
### API Stability Within a Released ROS Distribution | ||
|
||
`action_msgs` will not break public API within a released ROS distribution, i.e. no major releases once the ROS distribution is released. | ||
|
||
### Public API Declaration | ||
|
||
All message and service definition files located in `msg` and `srv` directories are considered part of the public API. | ||
|
||
## Change Control Process | ||
|
||
`action_msgs` 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). | ||
|
||
This includes: | ||
|
||
- all changes occur through a pull request | ||
- all pull request have two peer reviews | ||
- all pull request must pass CI on all [tier 1 platforms](https://www.ros.org/reps/rep-2000.html#support-tiers) | ||
- all pull request must resolve related documentation changes before merging | ||
|
||
## Documentation | ||
|
||
### Feature Documentation | ||
|
||
`action_msgs` has a list of provided [messages and services](README.md). | ||
New messages and services require their own documentation in order to be added. | ||
|
||
### Public API Documentation | ||
|
||
`action_msgs` has embedded API documentation and is hosted on [index.ros.org](Link appropriate page) | ||
There is documentation for all of the public API, and new additions to the public API require documentation before being added. | ||
|
||
### License | ||
|
||
The license for `action_msgs` 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`](../LICENSE) file. | ||
|
||
There is an automated test which runs a linter that ensures each file has a license statement. | ||
|
||
### Copyright Statements | ||
|
||
The copyright holders each provide a statement of copyright in each source code file in `action_msgs`. | ||
|
||
There is an automated test which runs a linter that ensures each file has at least one copyright statement. | ||
|
||
## Testing | ||
|
||
`action_msgs` is a package providing strictly message and service definitions and therefore does not require associated tests and has no coverage or performance requirements. | ||
|
||
## Dependencies | ||
|
||
`action_msgs` has the following ROS dependencies: | ||
* `builtin_interfaces` | ||
* `unique_identifier_msgs` | ||
|
||
It has several "buildtool" dependencies, which do not affect the resulting quality of the package, because they do not contribute to the public library API. | ||
|
||
## Platform Support | ||
|
||
`action_msgs` supports all of the tier 1 platforms as described in [REP-2000](https://www.ros.org/reps/rep-2000.html#support-tiers), and tests each change against all of them. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
This document is a declaration of software quality for the `builtin_interfaces` package, based on the guidelines in [REP-2004](https://www.ros.org/reps/rep-2004.html). | ||
|
||
# `builtin_interfaces` Quality Declaration | ||
|
||
The package `builtin_interfaces` 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 Requirements for Quality Level 1 in REP-2004](https://www.ros.org/reps/rep-2004.html). | ||
|
||
## Version Policy | ||
|
||
### Version Scheme | ||
|
||
`builtin_interfaces` 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), and is at or above a stable version, i.e. `>= 1.0.0`. | ||
|
||
### API Stability Within a Released ROS Distribution | ||
|
||
`builtin_interfaces` will not break public API within a released ROS distribution, i.e. no major releases once the ROS distribution is released. | ||
|
||
### Public API Declaration | ||
|
||
All message files located in the `msg` directory are considered part of the public API. | ||
|
||
## Change Control Process | ||
|
||
`builtin_interfaces` 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). | ||
|
||
This includes: | ||
|
||
- all changes occur through a pull request | ||
- all pull request have two peer reviews | ||
- all pull request must pass CI on all [tier 1 platforms](https://www.ros.org/reps/rep-2000.html#support-tiers) | ||
- all pull request must resolve related documentation changes before merging | ||
|
||
## Documentation | ||
|
||
### Feature Documentation | ||
|
||
`builtin_interfaces` has a list of provided [messages](README.md). | ||
New messages and services require their own documentation in order to be added. | ||
|
||
### Public API Documentation | ||
|
||
`builtin_interfaces` has embedded API documentation and is hosted on [index.ros.org](Link appropriate page) | ||
There is documentation for all of the public API, and new additions to the public API require documentation before being added. | ||
|
||
### License | ||
|
||
The license for `builtin_interfaces` 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`](../LICENSE) file. | ||
|
||
There is an automated test which runs a linter that ensures each file has a license statement. | ||
|
||
### Copyright Statements | ||
|
||
The copyright holders each provide a statement of copyright in each source code file in `builtin_interfaces`. | ||
|
||
There is an automated test which runs a linter that ensures each file has at least one copyright statement. | ||
|
||
## Testing | ||
|
||
`builtin_interfaces` is a package providing strictly message and therefore does not require associated tests and has no coverage or performance requirements. | ||
|
||
## Dependencies | ||
|
||
`builtin_interfaces` has the following ROS dependencies: | ||
* `builtin_interfaces` | ||
* `unique_identifier_msgs` | ||
|
||
It has several "buildtool" dependencies, which do not affect the resulting quality of the package, because they do not contribute to the public library API. | ||
|
||
## Platform Support | ||
|
||
`builtin_interfaces` supports all of the tier 1 platforms as described in [REP-2000](https://www.ros.org/reps/rep-2000.html#support-tiers), and tests each change against all of them. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
This document is a declaration of software quality for the `composition_interfaces` package, based on the guidelines in [REP-2004](https://www.ros.org/reps/rep-2004.html). | ||
|
||
# `composition_interfaces` Quality Declaration | ||
|
||
The package `composition_interfaces` 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 Requirements for Quality Level 1 in REP-2004](https://www.ros.org/reps/rep-2004.html). | ||
|
||
## Version Policy | ||
|
||
### Version Scheme | ||
|
||
`composition_interfaces` 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), and is at or above a stable version, i.e. `>= 1.0.0`. | ||
|
||
### API Stability Within a Released ROS Distribution | ||
|
||
`composition_interfaces` will not break public API within a released ROS distribution, i.e. no major releases once the ROS distribution is released. | ||
|
||
### Public API Declaration | ||
|
||
All service definition files located in the `srv` directory are considered part of the public API. | ||
|
||
## Change Control Process | ||
|
||
`composition_interfaces` 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). | ||
|
||
This includes: | ||
|
||
- all changes occur through a pull request | ||
- all pull request have two peer reviews | ||
- all pull request must pass CI on all [tier 1 platforms](https://www.ros.org/reps/rep-2000.html#support-tiers) | ||
- all pull request must resolve related documentation changes before merging | ||
|
||
## Documentation | ||
|
||
### Feature Documentation | ||
|
||
`composition_interfaces` has a list of provided [services](README.md). | ||
New messages and services require their own documentation in order to be added. | ||
|
||
### Public API Documentation | ||
|
||
`composition_interfaces` has embedded API documentation and is hosted on [index.ros.org](Link appropriate page) | ||
There is documentation for all of the public API, and new additions to the public API require documentation before being added. | ||
|
||
### License | ||
|
||
The license for `composition_interfaces` is Apache 2.0, and a summary is in each source file, the type is declared in the `package.xml` manifest file, and a full copy of the license is in the repository level [`LICENSE`](../LICENSE) file. | ||
|
||
There is an automated test which runs a linter that ensures each file has a license statement. | ||
|
||
### Copyright Statements | ||
|
||
The copyright holders each provide a statement of copyright in each source code file in `composition_interfaces`. | ||
|
||
There is an automated test which runs a linter that ensures each file has at least one copyright statement. | ||
|
||
## Testing | ||
|
||
`composition_interfaces` is a package providing service definitions and therefore does not require associated tests and has no coverage or performance requirements. | ||
|
||
## Dependencies | ||
|
||
`composition_interfaces` has the following ROS dependencies: | ||
* `composition_interfaces` | ||
* `unique_identifier_msgs` | ||
|
||
It has several "buildtool" dependencies, which do not affect the resulting quality of the package, because they do not contribute to the public library API. | ||
|
||
## Platform Support | ||
|
||
`composition_interfaces` supports all of the tier 1 platforms as described in [REP-2000](https://www.ros.org/reps/rep-2000.html#support-tiers), and tests each change against all of them. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
This document is a declaration of software quality for the `lifecycle_msgs` package, based on the guidelines in [REP-2004](https://www.ros.org/reps/rep-2004.html). | ||
|
||
# `lifecycle_msgs` Quality Declaration | ||
|
||
The package `lifecycle_msgs` 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 Requirements for Quality Level 1 in REP-2004](https://www.ros.org/reps/rep-2004.html). | ||
|
||
## Version Policy | ||
|
||
### Version Scheme | ||
|
||
`lifecycle_msgs` 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), and is at or above a stable version, i.e. `>= 1.0.0`. | ||
|
||
### API Stability Within a Released ROS Distribution | ||
|
||
`lifecycle_msgs` will not break public API within a released ROS distribution, i.e. no major releases once the ROS distribution is released. | ||
|
||
### Public API Declaration | ||
|
||
All message and service definition files located in the `msg` and `srv` directories are considered part of the public API. | ||
|
||
## Change Control Process | ||
|
||
`lifecycle_msgs` 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). | ||
|
||
This includes: | ||
|
||
- all changes occur through a pull request | ||
- all pull request have two peer reviews | ||
- all pull request must pass CI on all [tier 1 platforms](https://www.ros.org/reps/rep-2000.html#support-tiers) | ||
- all pull request must resolve related documentation changes before merging | ||
|
||
## Documentation | ||
|
||
### Feature Documentation | ||
|
||
`lifecycle_msgs` has a list of provided [messages and services](README.md). | ||
New messages and services require their own documentation in order to be added. | ||
|
||
### Public API Documentation | ||
|
||
`lifecycle_msgs` has embedded API documentation and is hosted on [index.ros.org](Link appropriate page) | ||
There is documentation for all of the public API, and new additions to the public API require documentation before being added. | ||
|
||
### License | ||
|
||
The license for `lifecycle_msgs` is Apache 2.0, and a summary is in each source file, the type is declared in the `package.xml` manifest file, and a full copy of the license is in the repository level [`LICENSE`](../LICENSE) file. | ||
|
||
There is an automated test which runs a linter that ensures each file has a license statement. | ||
|
||
### Copyright Statements | ||
|
||
The copyright holders each provide a statement of copyright in each source code file in `lifecycle_msgs`. | ||
|
||
There is an automated test which runs a linter that ensures each file has at least one copyright statement. | ||
|
||
## Testing | ||
|
||
`lifecycle_msgs` is a package providing strictly message and service definitions and therefore does not require associated tests and has no coverage or performance requirements. | ||
|
||
## Dependencies | ||
|
||
`lifecycle_msgs` has the following ROS dependencies: | ||
* `lifecycle_msgs` | ||
* `unique_identifier_msgs` | ||
|
||
It has several "buildtool" dependencies, which do not affect the resulting quality of the package, because they do not contribute to the public library API. | ||
|
||
## Platform Support | ||
|
||
`lifecycle_msgs` supports all of the tier 1 platforms as described in [REP-2000](https://www.ros.org/reps/rep-2000.html#support-tiers), and tests each change against all of them. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
This document is a declaration of software quality for the `rcl_interfaces` package, based on the guidelines in [REP-2004](https://www.ros.org/reps/rep-2004.html). | ||
|
||
# `rcl_interfaces` Quality Declaration | ||
|
||
The package `rcl_interfaces` 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 Requirements for Quality Level 1 in REP-2004](https://www.ros.org/reps/rep-2004.html). | ||
|
||
## Version Policy | ||
|
||
### Version Scheme | ||
|
||
`rcl_interfaces` 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), and is at or above a stable version, i.e. `>= 1.0.0`. | ||
|
||
### API Stability Within a Released ROS Distribution | ||
|
||
`rcl_interfaces` will not break public API within a released ROS distribution, i.e. no major releases once the ROS distribution is released. | ||
|
||
### Public API Declaration | ||
|
||
All message and service definition files located in `msg` and `srv` directories are considered part of the public API. | ||
|
||
## Change Control Process | ||
|
||
`rcl_interfaces` 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). | ||
|
||
This includes: | ||
|
||
- all changes occur through a pull request | ||
- all pull request have two peer reviews | ||
- all pull request must pass CI on all [tier 1 platforms](https://www.ros.org/reps/rep-2000.html#support-tiers) | ||
- all pull request must resolve related documentation changes before merging | ||
|
||
## Documentation | ||
|
||
### Feature Documentation | ||
|
||
`rcl_interfaces` has a list of provided [messages and services](README.md). | ||
New messages and services require their own documentation in order to be added. | ||
|
||
### Public API Documentation | ||
|
||
`rcl_interfaces` has embedded API documentation and is hosted on [index.ros.org](Link appropriate page) | ||
There is documentation for all of the public API, and new additions to the public API require documentation before being added. | ||
|
||
### License | ||
|
||
The license for `rcl_interfaces` 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`](../LICENSE) file. | ||
|
||
There is an automated test which runs a linter that ensures each file has a license statement. | ||
|
||
### Copyright Statements | ||
|
||
The copyright holders each provide a statement of copyright in each source code file in `rcl_interfaces`. | ||
|
||
There is an automated test which runs a linter that ensures each file has at least one copyright statement. | ||
|
||
## Testing | ||
|
||
`rcl_interfaces` is a package providing strictly message and service definitions and therefore does not require associated tests and has no coverage or performance requirements. | ||
|
||
## Dependencies | ||
|
||
`rcl_interfaces` has the following ROS dependencies: | ||
* `rcl_interfaces` | ||
* `unique_identifier_msgs` | ||
|
||
It has several "buildtool" dependencies, which do not affect the resulting quality of the package, because they do not contribute to the public library API. | ||
|
||
## Platform Support | ||
|
||
`rcl_interfaces` supports all of the tier 1 platforms as described in [REP-2000](https://www.ros.org/reps/rep-2000.html#support-tiers), and tests each change against all of them. |
Oops, something went wrong.