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: rmw_fastrtps_cpp/QUALITY_DECLARATION.md
+66-8Lines changed: 66 additions & 8 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 `rmw_fastrtps_cpp` pa
2
2
3
3
# `rmw_fastrtps_cpp` Quality Declaration
4
4
5
-
The package `rmw_fastrtps_cpp` claims to be in the **Quality Level 4** category.
5
+
The package `rmw_fastrtps_cpp` 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 Requirements for Quality Level 3 in REP-2004](https://www.ros.org/reps/rep-2004.html).
8
8
9
9
## Version Policy [1]
10
10
@@ -49,7 +49,7 @@ Following the recommended guidelines for ROS Core packages, all pull requests mu
49
49
50
50
### Continuous Integration [2.iv]
51
51
52
-
All pull request must pass CI on all [tier 1 platforms](https://www.ros.org/reps/rep-2000.html#support-tiers)
52
+
All pull request must pass CI on all [tier 1 platforms](https://www.ros.org/reps/rep-2000.html#support-tiers).
53
53
54
54
### Documentation Policy [2.v]
55
55
@@ -72,15 +72,15 @@ The license for `rmw_fastrtps_cpp` is Apache 2.0, and a summary is in each sourc
72
72
73
73
There is an automated test which runs a linter that ensures each file has a license statement.
74
74
75
-
Most recent test results can be found [here](https://ci.ros2.org/view/nightly/job/nightly_linux_release/1525/testReport/rmw_fastrtps_cpp/copyright/)
75
+
Most recent test results can be found [here](https://ci.ros2.org/view/nightly/job/nightly_linux_release/lastBuild/testReport/rmw_fastrtps_cpp/copyright/)
76
76
77
77
### Copyright Statements [3.iv]
78
78
79
79
The copyright holders each provide a statement of copyright in each source code file in `rmw_fastrtps_cpp`.
80
80
81
81
There is an automated test which runs a linter that ensures each file has at least one copyright statement.
82
82
83
-
The results of the test can be found [here](https://ci.ros2.org/view/nightly/job/nightly_linux_release/1525/testReport/rmw_fastrtps_cpp/copyright/).
83
+
The results of the test can be found [here](https://ci.ros2.org/view/nightly/job/nightly_linux_release/lastBuild/testReport/rmw_fastrtps_cpp/copyright/).
84
84
85
85
## Testing [4]
86
86
@@ -94,7 +94,19 @@ There is no API testing in `rmw_fastrtps_cpp`.
94
94
95
95
### Coverage [4.iii]
96
96
97
-
`rmw_fastrtps_cpp` does not currently track test coverage.
97
+
`rmw_fastrtps_cpp` follows the recommendations for ROS Core packages in the [ROS 2 Developer Guide](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#coverage), and opts to use branch coverage instead of line coverage.
98
+
99
+
This includes:
100
+
101
+
- tracking and reporting line coverage statistics
102
+
- achieving and maintaining a reasonable branch line coverage (90-100%)
103
+
- no lines are manually skipped in coverage calculations
104
+
105
+
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.
106
+
107
+
Current coverage statistics can be viewed [here](https://ci.ros2.org/job/ci_linux_coverage/lastSuccessfulBuild/cobertura/src_ros2_rmw_fastrtps_rmw_fastrtps_cpp_src/). This package does not yet meet the 95% coverage guideline.
108
+
109
+
A summary of how these statistics are calculated can be found in the [ROS 2 On-boarding guide](https://index.ros.org/doc/ros2/Contributing/ROS-2-On-boarding-Guide/#note-on-coverage-runs).
98
110
99
111
### Performance [4.iv]
100
112
@@ -104,7 +116,7 @@ There is no API testing in `rmw_fastrtps_cpp`.
104
116
105
117
`rmw_fastrtps_cpp` uses and passes all the standard linters and static analysis tools for a C++ package as described in the [ROS 2 Developer Guide](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#linters).
106
118
107
-
Results of the nightly linter tests can be found [here](https://ci.ros2.org/view/nightly/job/nightly_linux_release/1525/testReport/rmw_fastrtps_cpp).
119
+
Results of the nightly linter tests can be found [here](https://ci.ros2.org/view/nightly/job/nightly_linux_release/lastBuild/testReport/rmw_fastrtps_cpp).
108
120
109
121
## Dependencies [5]
110
122
@@ -140,6 +152,52 @@ Currently nightly results can be seen here:
0 commit comments