Skip to content

Commit a9c3220

Browse files
Update quality declaration documents (#245)
Signed-off-by: Christophe Bedard <christophe.bedard@apex.ai>
1 parent 9da4a19 commit a9c3220

File tree

10 files changed

+69
-58
lines changed

10 files changed

+69
-58
lines changed

diagnostic_msgs/QUALITY_DECLARATION.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Below are the rationales, notes, and caveats for this claim, organized by each r
1010

1111
### Version Scheme [1.i]
1212

13-
`diagnostic_msgs` uses `semver` according to the recommendation for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#versioning).
13+
`diagnostic_msgs` uses `semver` according to the recommendation for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#versioning).
1414

1515
### Version Stability [1.ii]
1616

@@ -31,15 +31,16 @@ All message and service definition files located in `msg` and `srv` directories
3131

3232
## Change Control Process [2]
3333

34-
`diagnostic_msgs` follows the recommended guidelines for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#quality-practices).
34+
`diagnostic_msgs` follows the recommended guidelines for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#quality-practices).
3535

3636
### Change Requests [2.i]
3737

3838
This package requires that all changes occur through a pull request.
3939

4040
### Contributor Origin [2.ii]
4141

42-
This package uses DCO as its confirmation of contributor origin policy. More information can be found in [CONTRIBUTING](../CONTRIBUTING.md).
42+
This package uses DCO as its confirmation of contributor origin policy.
43+
More information can be found in [CONTRIBUTING](../CONTRIBUTING.md).
4344

4445
### Peer Review Policy [2.iii]
4546

@@ -80,7 +81,7 @@ There are no currently copyrighted source files in this package.
8081

8182
### Linters and Static Analysis [4.v]
8283

83-
`diagnostic_msgs` uses and passes all the standard linters and static analysis tools for its generated C++ and Python code to ensure it follows the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#linters-and-static-analysis).
84+
`diagnostic_msgs` uses and passes all the standard linters and static analysis tools for its generated C++ and Python code to ensure it follows the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#linters-and-static-analysis).
8485

8586
Results of the nightly linter tests can be found [here](http://build.ros2.org/view/Rpr/job/Rpr__common_interfaces__ubuntu_focal_amd64/lastCompletedBuild/testReport/diagnostic_msgs/).
8687

@@ -89,9 +90,9 @@ Results of the nightly linter tests can be found [here](http://build.ros2.org/vi
8990
### Direct Runtime ROS Dependencies [5.i]/[5.ii]
9091

9192
`diagnostic_msgs` has the following runtime ROS dependencies, which are at **Quality Level 1**
92-
* `builtin_interfaces`: [QUALITY DECLARATION](https://github.com/ros2/rcl_interfaces/tree/master/builtin_interfaces/QUALITY_DECLARATION.md)
93+
* `builtin_interfaces`: [QUALITY DECLARATION](https://github.com/ros2/rcl_interfaces/tree/rolling/builtin_interfaces/QUALITY_DECLARATION.md)
9394
* `geometry_msgs`: [QUALITY DECLARATION](../geometry_msgs/QUALITY_DECLARATION.md)
94-
* `rosidl_default_runtime` [QUALITY DECLARATION](https://github.com/ros2/rosidl_defaults/tree/master/rosidl_default_runtime/QUALITY_DECLARATION.md)
95+
* `rosidl_default_runtime` [QUALITY DECLARATION](https://github.com/ros2/rosidl_defaults/tree/rolling/rosidl_default_runtime/QUALITY_DECLARATION.md)
9596
* `std_msgs`: [QUALITY DECLARATION](../std_msgs/QUALITY_DECLARATION.md)
9697

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

geometry_msgs/QUALITY_DECLARATION.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Below are the rationales, notes, and caveats for this claim, organized by each r
1010

1111
### Version Scheme [1.i]
1212

13-
`geometry_msgs` uses `semver` according to the recommendation for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#versioning).
13+
`geometry_msgs` uses `semver` according to the recommendation for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#versioning).
1414

1515
### Version Stability [1.ii]
1616

@@ -31,15 +31,16 @@ All message and service definition files located in `msg` and `srv` directories
3131

3232
## Change Control Process [2]
3333

34-
`geometry_msgs` follows the recommended guidelines for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#quality-practices).
34+
`geometry_msgs` follows the recommended guidelines for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#quality-practices).
3535

3636
### Change Requests [2.i]
3737

3838
This package requires that all changes occur through a pull request.
3939

4040
### Contributor Origin [2.ii]
4141

42-
This package uses DCO as its confirmation of contributor origin policy. More information can be found in [CONTRIBUTING](../CONTRIBUTING.md).
42+
This package uses DCO as its confirmation of contributor origin policy.
43+
More information can be found in [CONTRIBUTING](../CONTRIBUTING.md).
4344

4445
### Peer Review Policy [2.iii]
4546

@@ -80,7 +81,7 @@ There are no currently copyrighted source files in this package.
8081

8182
### Linters and Static Analysis [4.v]
8283

83-
`geometry_msgs` uses and passes all the standard linters and static analysis tools for its generated C++ and Python code to ensure it follows the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#linters-and-static-analysis).
84+
`geometry_msgs` uses and passes all the standard linters and static analysis tools for its generated C++ and Python code to ensure it follows the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#linters-and-static-analysis).
8485

8586
Results of the nightly linter tests can be found [here](http://build.ros2.org/view/Rpr/job/Rpr__common_interfaces__ubuntu_focal_amd64/lastCompletedBuild/testReport/geometry_msgs/).
8687

@@ -89,7 +90,7 @@ Results of the nightly linter tests can be found [here](http://build.ros2.org/vi
8990
### Direct Runtime ROS Dependencies [5.i]/[5.ii]
9091

9192
`geometry_msgs` has the following runtime ROS dependencies, which are at **Quality Level 1**:
92-
* `rosidl_default_runtime` [QUALITY DECLARATION](https://github.com/ros2/rosidl_defaults/tree/master/rosidl_default_runtime/QUALITY_DECLARATION.md)
93+
* `rosidl_default_runtime` [QUALITY DECLARATION](https://github.com/ros2/rosidl_defaults/tree/rolling/rosidl_default_runtime/QUALITY_DECLARATION.md)
9394
* `std_msgs`: [QUALITY DECLARATION](../std_msgs/QUALITY_DECLARATION.md)
9495

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

nav_msgs/QUALITY_DECLARATION.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Below are the rationales, notes, and caveats for this claim, organized by each r
1010

1111
### Version Scheme [1.i]
1212

13-
`nav_msgs` uses `semver` according to the recommendation for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#versioning).
13+
`nav_msgs` uses `semver` according to the recommendation for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#versioning).
1414

1515
### Version Stability [1.ii]
1616

@@ -31,15 +31,16 @@ All message and service definition files located in `msg` and `srv` directories
3131

3232
## Change Control Process [2]
3333

34-
`nav_msgs` follows the recommended guidelines for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#quality-practices).
34+
`nav_msgs` follows the recommended guidelines for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#quality-practices).
3535

3636
### Change Requests [2.i]
3737

3838
This package requires that all changes occur through a pull request.
3939

4040
### Contributor Origin [2.ii]
4141

42-
This package uses DCO as its confirmation of contributor origin policy. More information can be found in [CONTRIBUTING](../CONTRIBUTING.md).
42+
This package uses DCO as its confirmation of contributor origin policy.
43+
More information can be found in [CONTRIBUTING](../CONTRIBUTING.md).
4344

4445
### Peer Review Policy [2.iii]
4546

@@ -80,7 +81,7 @@ There are no currently copyrighted source files in this package.
8081

8182
### Linters and Static Analysis [4.v]
8283

83-
`nav_msgs` uses and passes all the standard linters and static analysis tools for its generated C++ and Python code to ensure it follows the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#linters-and-static-analysis).
84+
`nav_msgs` uses and passes all the standard linters and static analysis tools for its generated C++ and Python code to ensure it follows the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#linters-and-static-analysis).
8485

8586
Results of the nightly linter tests can be found [here](http://build.ros2.org/view/Rpr/job/Rpr__common_interfaces__ubuntu_focal_amd64/lastCompletedBuild/testReport/nav_msgs/).
8687

@@ -89,9 +90,9 @@ Results of the nightly linter tests can be found [here](http://build.ros2.org/vi
8990
### Direct Runtime ROS Dependencies [5.i]/[5.ii]
9091

9192
`nav_msgs` has the following runtime ROS dependencies, which are at **Quality Level 1**:
92-
* `builtin_interfaces`: [QUALITY DECLARATION](https://github.com/ros2/rcl_interfaces/tree/master/builtin_interfaces/QUALITY_DECLARATION.md)
93+
* `builtin_interfaces`: [QUALITY DECLARATION](https://github.com/ros2/rcl_interfaces/tree/rolling/builtin_interfaces/QUALITY_DECLARATION.md)
9394
* `geometry_msgs`: [QUALITY DECLARATION](../geometry_msgs/QUALITY_DECLARATION.md)
94-
* `rosidl_default_runtime` [QUALITY DECLARATION](https://github.com/ros2/rosidl_defaults/tree/master/rosidl_default_runtime/QUALITY_DECLARATION.md)
95+
* `rosidl_default_runtime` [QUALITY DECLARATION](https://github.com/ros2/rosidl_defaults/tree/rolling/rosidl_default_runtime/QUALITY_DECLARATION.md)
9596
* `std_msgs`: [QUALITY DECLARATION](../std_msgs/QUALITY_DECLARATION.md)
9697

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

sensor_msgs/QUALITY_DECLARATION.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Below are the rationales, notes, and caveats for this claim, organized by each r
1010

1111
### Version Scheme [1.i]
1212

13-
`sensor_msgs` uses `semver` according to the recommendation for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#versioning).
13+
`sensor_msgs` uses `semver` according to the recommendation for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#versioning).
1414

1515
### Version Stability [1.ii]
1616

@@ -27,19 +27,21 @@ All message and service definition files located in `include`, `msg` and `srv` d
2727

2828
### ABI Stability Within a Released ROS Distribution [1.v]/[1.vi]
2929

30-
`sensor_msgs` contains C++ code and is therefore concerned with ABI stability. It will not break ABI stability within a released ROS distribution.
30+
`sensor_msgs` contains C++ code and is therefore concerned with ABI stability.
31+
It will not break ABI stability within a released ROS distribution.
3132

3233
## Change Control Process [2]
3334

34-
`sensor_msgs` follows the recommended guidelines for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#quality-practices).
35+
`sensor_msgs` follows the recommended guidelines for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#quality-practices).
3536

3637
### Change Requests [2.i]
3738

3839
This package requires that all changes occur through a pull request.
3940

4041
### Contributor Origin [2.ii]
4142

42-
This package uses DCO as its confirmation of contributor origin policy. More information can be found in [CONTRIBUTING](../CONTRIBUTING.md).
43+
This package uses DCO as its confirmation of contributor origin policy.
44+
More information can be found in [CONTRIBUTING](../CONTRIBUTING.md).
4345

4446
### Peer Review Policy [2.iii]
4547

@@ -94,7 +96,7 @@ Results of these API tests can be found [here](http://build.ros2.org/view/Rpr/jo
9496

9597
### Coverage [4.iii]
9698

97-
`sensor_msgs` follows the recommendations for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#code-coverage), and opts to use line coverage instead of branch coverage.
99+
`sensor_msgs` follows the recommendations for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#code-coverage), and opts to use line coverage instead of branch coverage.
98100

99101
This includes:
100102

@@ -119,7 +121,7 @@ Changes that introduce regressions in performance must be adequately justified i
119121

120122
### Linters and Static Analysis [4.v]
121123

122-
`sensor_msgs` uses and passes all the standard linters and static analysis tools for its generated C++ and Python code to ensure it follows the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#linters-and-static-analysis).
124+
`sensor_msgs` uses and passes all the standard linters and static analysis tools for its generated C++ and Python code to ensure it follows the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#linters-and-static-analysis).
123125

124126
Results of the nightly linter tests can be found [here](http://build.ros2.org/view/Rpr/job/Rpr__common_interfaces__ubuntu_focal_amd64/lastCompletedBuild/testReport/sensor_msgs/).
125127

@@ -128,9 +130,9 @@ Results of the nightly linter tests can be found [here](http://build.ros2.org/vi
128130
### Direct Runtime ROS Dependencies [5.i]/[5.ii]
129131

130132
`sensor_msgs` has the following runtime ROS dependencies, which are at **Quality Level 1**:
131-
* `builtin_interfaces`: [QUALITY DECLARATION](https://github.com/ros2/rcl_interfaces/tree/master/builtin_interfaces/QUALITY_DECLARATION.md)
133+
* `builtin_interfaces`: [QUALITY DECLARATION](https://github.com/ros2/rcl_interfaces/tree/rolling/builtin_interfaces/QUALITY_DECLARATION.md)
132134
* `geometry_msgs`: [QUALITY DECLARATION](../geometry_msgs/QUALITY_DECLARATION.md)
133-
* `rosidl_default_runtime` [QUALITY DECLARATION](https://github.com/ros2/rosidl_defaults/tree/master/rosidl_default_runtime/QUALITY_DECLARATION.md)
135+
* `rosidl_default_runtime` [QUALITY DECLARATION](https://github.com/ros2/rosidl_defaults/tree/rolling/rosidl_default_runtime/QUALITY_DECLARATION.md)
134136
* `std_msgs`: [QUALITY DECLARATION](../std_msgs/QUALITY_DECLARATION.md)
135137

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

shape_msgs/QUALITY_DECLARATION.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Below are the rationales, notes, and caveats for this claim, organized by each r
1010

1111
### Version Scheme [1.i]
1212

13-
`shape_msgs` uses `semver` according to the recommendation for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#versioning).
13+
`shape_msgs` uses `semver` according to the recommendation for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#versioning).
1414

1515
### Version Stability [1.ii]
1616

@@ -31,15 +31,16 @@ All message and service definition files located in `msg` and `srv` directories
3131

3232
## Change Control Process [2]
3333

34-
`shape_msgs` follows the recommended guidelines for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#quality-practices).
34+
`shape_msgs` follows the recommended guidelines for ROS Core packages in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#quality-practices).
3535

3636
### Change Requests [2.i]
3737

3838
This package requires that all changes occur through a pull request.
3939

4040
### Contributor Origin [2.ii]
4141

42-
This package uses DCO as its confirmation of contributor origin policy. More information can be found in [CONTRIBUTING](../CONTRIBUTING.md).
42+
This package uses DCO as its confirmation of contributor origin policy.
43+
More information can be found in [CONTRIBUTING](../CONTRIBUTING.md).
4344

4445
### Peer Review Policy [2.iii]
4546

@@ -80,7 +81,7 @@ There are no currently copyrighted source files in this package.
8081

8182
### Linters and Static Analysis [4.v]
8283

83-
`shape_msgs` uses and passes all the standard linters and static analysis tools for its generated C++ and Python code to ensure it follows the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#linters-and-static-analysis).
84+
`shape_msgs` uses and passes all the standard linters and static analysis tools for its generated C++ and Python code to ensure it follows the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html#linters-and-static-analysis).
8485

8586
Results of the nightly linter tests can be found [here](http://build.ros2.org/view/Rpr/job/Rpr__common_interfaces__ubuntu_focal_amd64/lastCompletedBuild/testReport/shape_msgs/).
8687

@@ -90,7 +91,7 @@ Results of the nightly linter tests can be found [here](http://build.ros2.org/vi
9091

9192
`shape_msgs` has the following runtime ROS dependencies, which are at **Quality Level 1**:
9293
* `geometry_msgs`: [QUALITY DECLARATION](../geometry_msgs/QUALITY_DECLARATION.md)
93-
* `rosidl_default_runtime` [QUALITY DECLARATION](https://github.com/ros2/rosidl_defaults/tree/master/rosidl_default_runtime/QUALITY_DECLARATION.md)
94+
* `rosidl_default_runtime` [QUALITY DECLARATION](https://github.com/ros2/rosidl_defaults/tree/rolling/rosidl_default_runtime/QUALITY_DECLARATION.md)
9495

9596
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.
9697

0 commit comments

Comments
 (0)