You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: rcl/QUALITY_DECLARATION.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@ This document is a declaration of software quality for the `rcl` package, based
2
2
3
3
# `rcl` Quality Declaration
4
4
5
-
The package `rcl` claims to be in the **Quality Level 4** category.
5
+
The package `rcl` claims to be in the **Quality Level 3** category.
6
6
7
7
Below are the rationales, notes, and caveats for this claim, organized by each requirement listed in the [Package Quality Categories in REP-2004](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#package-quality-categories).
8
8
@@ -101,7 +101,9 @@ Currently nightly test results can be seen here:
101
101
102
102
### Public API Testing [4.ii]
103
103
104
-
Most of the functionality of the declared API in this package is covered in its unit tests. Currently it has a line coverage of [77%](https://ci.ros2.org/job/ci_linux_coverage/85/cobertura/src_ros2_rcl_rcl_src_rcl/).
104
+
Each part of the public API has 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.
105
+
106
+
The following functions are partially supported: `rcl_take_loaned_message`, `rcl_return_loaned_message_from_subscription`, `rcl_borrow_loaned_message`, `rcl_return_loaned_message_from_publisher` and `rcl_publish_loaned_message` because they are not currently supported on Tier 1 RMW providers.
105
107
106
108
### Coverage [4.iii]
107
109
@@ -114,7 +116,7 @@ This includes:
114
116
115
117
Changes are required to make a best effort to keep or increase coverage before being accepted, but decreases are allowed if properly justified and accepted by reviewers.
116
118
117
-
Current coverage statistics can be viewed (77%) [here](https://ci.ros2.org/job/ci_linux_coverage/85/cobertura/src_ros2_rcl_rcl_src_rcl/). Current coverage statistics need to be improved to reach a higher quality level.
119
+
Current coverage statistics can be viewed [here](https://ci.ros2.org/job/nightly_linux_coverage/lastSuccessfulBuild/cobertura/src_ros2_rcl_rcl_src_rcl/). A description of how coverage statistics are calculated is summarized in this page ["ROS 2 Onboarding Guide"](https://index.ros.org/doc/ros2/Contributing/ROS-2-On-boarding-Guide/#note-on-coverage-runs).
118
120
119
121
### Performance [4.iv]
120
122
@@ -167,7 +169,7 @@ It is **Quality Level 4**, see its [Quality Declaration document](https://github
167
169
168
170
The `rcutils` package provides an API which contains common utilities and data structures needed when programming in C.
169
171
170
-
It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rcutils/blob/master/QUALITY_DECLARATION.md).
172
+
It is **Quality Level 2**, see its [Quality Declaration document](https://github.com/ros2/rcutils/blob/master/QUALITY_DECLARATION.md).
Copy file name to clipboardExpand all lines: rcl_action/QUALITY_DECLARATION.md
+21-7Lines changed: 21 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@ This document is a declaration of software quality for the `rcl_action` package,
2
2
3
3
# `rcl_action` Quality Declaration
4
4
5
-
The package `rcl_action` claims to be in the **Quality Level 4** category.
5
+
The package `rcl_action` claims to be in the **Quality Level 3** category.
6
6
7
-
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).
7
+
Below are the rationales, notes, and caveats for this claim, organized by each requirement listed in the [Package Quality Categories in REP-2004](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#package-quality-categories).
8
8
9
9
## Version Policy [1]
10
10
@@ -88,15 +88,29 @@ The results of the test can be found [here](https://ci.ros2.org/view/nightly/job
88
88
89
89
`rcl_action` has feature tests, which test for proper node state transitions.
90
90
The tests are located in the [test](test) subdirectory.
91
+
New features are required to have tests before being added.
The tests are located in the [test](test) subdirectory.
100
+
Each part of the public API has 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.
96
101
97
102
### Coverage [4.iii]
98
103
99
-
`rcl_action` does not currently track test coverage.
104
+
`rcl_action` follows the recommendations for ROS Core packages in the [ROS 2 Developer Guide](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#code-coverage), and opts to use line coverage instead of branch coverage.
105
+
106
+
This includes:
107
+
108
+
- tracking and reporting line coverage statistics
109
+
- no lines are manually skipped in coverage calculations
110
+
111
+
Changes are required to make a best effort to keep or increase coverage before being accepted, but decreases are allowed if properly justified and accepted by reviewers.
112
+
113
+
Current coverage statistics can be viewed [here](https://ci.ros2.org/job/nightly_linux_coverage/lastSuccessfulBuild/cobertura/src_ros2_rcl_rcl_action_src_rcl_action/). A description of how coverage statistics are calculated is summarized in this page ["ROS 2 Onboarding Guide"](https://index.ros.org/doc/ros2/Contributing/ROS-2-On-boarding-Guide/#note-on-coverage-runs).
100
114
101
115
### Performance [4.iv]
102
116
@@ -129,13 +143,13 @@ It is **Quality Level 4**, see its [Quality Declaration document](https://github
129
143
130
144
`rcl` is the ROS 2 client library in C.
131
145
132
-
It is **Quality Level 4**, see its [Quality Declaration document](../rcl/QUALITY_DECLARATION).
146
+
It is **Quality Level 3**, see its [Quality Declaration document](../rcl/QUALITY_DECLARATION).
133
147
134
148
#### `rcutils`
135
149
136
150
`rcutils` provides commonly used functionality in C.
137
151
138
-
It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rcutils/blob/master/QUALITY_DECLARATION.md).
152
+
It is **Quality Level 2**, see its [Quality Declaration document](https://github.com/ros2/rcutils/blob/master/QUALITY_DECLARATION.md).
Copy file name to clipboardExpand all lines: rcl_lifecycle/QUALITY_DECLARATION.md
+21-5Lines changed: 21 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@ This document is a declaration of software quality for the `rcl_lifecycle` packa
2
2
3
3
# `rcl_lifecycle` Quality Declaration
4
4
5
-
The package `rcl_lifecycle` claims to be in the **Quality Level 4** category.
5
+
The package `rcl_lifecycle` claims to be in the **Quality Level 3** category.
6
6
7
-
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).
7
+
Below are the rationales, notes, and caveats for this claim, organized by each requirement listed in the [Package Quality Categories in REP-2004](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#package-quality-categories).
8
8
9
9
## Version Policy [1]
10
10
@@ -88,14 +88,30 @@ The results of the test can be found [here](https://ci.ros2.org/view/nightly/job
88
88
89
89
`rcl_lifecycle` has feature tests, which test for proper node state transitions.
90
90
The tests are located in the [test](test) subdirectory.
91
+
New features are required to have tests before being added.
Much of the API in `rcl_lifecycle` is tested in the aforementioned feature tests, but it is not tested explicitly.
101
+
Each part of the public API has 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.
95
102
96
103
### Coverage [4.iii]
97
104
98
-
`rcl_lifecycle` does not currently track test coverage.
105
+
`rcl_lifecycle` follows the recommendations for ROS Core packages in the [ROS 2 Developer Guide](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#code-coverage), and opts to use line coverage instead of branch coverage.
106
+
107
+
This includes:
108
+
109
+
- tracking and reporting line coverage statistics
110
+
- no lines are manually skipped in coverage calculations
111
+
112
+
Changes are required to make a best effort to keep or increase coverage before being accepted, but decreases are allowed if properly justified and accepted by reviewers.
113
+
114
+
Current coverage statistics can be viewed [here](https://ci.ros2.org/job/nightly_linux_coverage/lastSuccessfulBuild/cobertura/src_ros2_rcl_rcl_lifecycle_src/). A description of how coverage statistics are calculated is summarized in this page ["ROS 2 Onboarding Guide"](https://index.ros.org/doc/ros2/Contributing/ROS-2-On-boarding-Guide/#note-on-coverage-runs).
99
115
100
116
### Performance [4.iv]
101
117
@@ -128,7 +144,7 @@ It is **Quality Level 4**, see its [Quality Declaration document](https://github
128
144
129
145
`rcl` is the ROS 2 client library in C.
130
146
131
-
It is **Quality Level 4**, see its [Quality Declaration document](../rcl/QUALITY_DECLARATION).
147
+
It is **Quality Level 3**, see its [Quality Declaration document](../rcl/QUALITY_DECLARATION).
Copy file name to clipboardExpand all lines: rcl_yaml_param_parser/QUALITY_DECLARATION.md
+24-7Lines changed: 24 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@ This document is a declaration of software quality for the `rcl_yaml_param_parse
2
2
3
3
# `rcl_yaml_param_parser` Quality Declaration
4
4
5
-
The package `rcl_yaml_param_parser` claims to be in the **Quality Level 4** category.
5
+
The package `rcl_yaml_param_parser` claims to be in the **Quality Level 3** category.
6
6
7
-
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).
7
+
Below are the rationales, notes, and caveats for this claim, organized by each requirement listed in the [Package Quality Categories in REP-2004](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#package-quality-categories).
8
8
9
9
## Version Policy [1]
10
10
@@ -59,10 +59,12 @@ All pull requests must resolve related documentation changes before merging.
59
59
60
60
### Feature Documentation [3.i]
61
61
62
-
`rcl_yaml_param_parser`does not have feature documentation.
62
+
`rcl_yaml_param_parser`provides the main elements of its API listed using doxygen and is hosted [here](http://docs.ros2.org/latest/api/rcl_yaml_param_parser/index.html).
63
63
64
64
### Public API Documentation [3.ii]
65
65
66
+
`rcl_yaml_param_parser` has embedded API documentation and it is generated using doxygen. Currently, its latest version is hosted [here](http://docs.ros2.org/latest/api/rcl_yaml_param_parser/index.html). Latest version has to be generated before considering this item fully resolved.
67
+
66
68
All of `rcl_yaml_param_parser` has embedded API documentation. It is not yet hosted publicly.
67
69
68
70
### License [3.iii]
@@ -85,15 +87,30 @@ The results of the test can be found [here](https://ci.ros2.org/view/nightly/job
85
87
86
88
### Feature Testing [4.i]
87
89
88
-
`rcl_yaml_param_parser` has feature tests, which ensure that a wide variety of yaml files are checked for parsing.
90
+
Most features in `rcl_yaml_param_parser` have corresponding tests which simulate typical usage, and they are located in the [`test`](./test) directory.
91
+
New features are required to have tests before being added.
Much of the API in `rcl_yaml_param_parser` is tested in the aforementioned feature tests, but it is not tested explicitly.
100
+
Each part of the public API has 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.
93
101
94
102
### Coverage [4.iii]
95
103
96
-
`rcl_yaml_param_parser` does not currently track test coverage.
104
+
`rcl_yaml_param_parser` follows the recommendations for ROS Core packages in the [ROS 2 Developer Guide](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#code-coverage), and opts to use line coverage instead of branch coverage.
105
+
106
+
This includes:
107
+
108
+
- tracking and reporting line coverage statistics
109
+
- no lines are manually skipped in coverage calculations
110
+
111
+
Changes are required to make a best effort to keep or increase coverage before being accepted, but decreases are allowed if properly justified and accepted by reviewers.
112
+
113
+
Current coverage statistics can be viewed [here](https://ci.ros2.org/job/nightly_linux_coverage/lastSuccessfulBuild/cobertura/src_ros2_rcl_rcl_yaml_param_parser_src/). A description of how coverage statistics are calculated is summarized in this page ["ROS 2 Onboarding Guide"](https://index.ros.org/doc/ros2/Contributing/ROS-2-On-boarding-Guide/#note-on-coverage-runs).
97
114
98
115
### Performance [4.iv]
99
116
@@ -118,7 +135,7 @@ It also has several test dependencies, which do not affect the resulting quality
118
135
119
136
`rcutils` provides commonly used functionality in C.
120
137
121
-
It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rcutils/blob/master/QUALITY_DECLARATION.md).
138
+
It is **Quality Level 3**, see its [Quality Declaration document](https://github.com/ros2/rcutils/blob/master/QUALITY_DECLARATION.md).
0 commit comments