Skip to content

Commit c45683f

Browse files
Update quality declaration document (#112)
Signed-off-by: Christophe Bedard <[email protected]>
1 parent 3877632 commit c45683f

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

rcl_logging_spdlog/QUALITY_DECLARATION.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document is a declaration of software quality for the `rcl_logging_spdlog`
44

55
The package `rcl_logging_spdlog` claims to be in the **Quality Level 1** category.
66

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://www.ros.org/reps/rep-2004.html) of the ROS2 developer guide.
7+
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).
88

99
## Version Policy [1]
1010

@@ -44,7 +44,8 @@ All changes will occur through a pull request, check [ROS 2 Developer Guide](htt
4444

4545
### Contributor Origin [2.ii]
4646

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

4950
### Peer Review Policy [2.iii]
5051

@@ -78,19 +79,21 @@ All pull requests must resolve related documentation changes before merging.
7879

7980
The license for `rcl_logging_spdlog` is Apache 2.0, and a summary is in each source file, the type is declared in the [`package.xml`](./package.xml) manifest file, and a full copy of the license is in the [`LICENSE`](../LICENSE) file.
8081

81-
There is an automated test which runs a linter that ensures each file has a license statement. [Here](https://ci.ros2.org/view/nightly/job/nightly_linux_release/lastSuccessfulBuild/testReport/rcl_logging_spdlog/) can be found a list with the latest results of the various linters being run on the package.
82+
There is an automated test which runs a linter that ensures each file has a license statement.
83+
[Here](https://ci.ros2.org/view/nightly/job/nightly_linux_release/lastSuccessfulBuild/testReport/rcl_logging_spdlog/) can be found a list with the latest results of the various linters being run on the package.
8284

8385
### Copyright Statements [3.iv]
8486

8587
The copyright holders each provide a statement of copyright in each source code file in `rcl_logging_spdlog`.
8688

87-
There is an automated test which runs a linter that ensures each file has at least one copyright statement. Latest linter result report can be seen [here](https://ci.ros2.org/view/nightly/job/nightly_linux_release/lastSuccessfulBuild/testReport/rcl_logging_spdlog/copyright/).
89+
There is an automated test which runs a linter that ensures each file has at least one copyright statement.
90+
Latest linter result report can be seen [here](https://ci.ros2.org/view/nightly/job/nightly_linux_release/lastSuccessfulBuild/testReport/rcl_logging_spdlog/copyright/).
8891

8992
## Testing [4]
9093

9194
### Feature Testing [4.i]
9295

93-
Each feature in `rcl_logging_spdlog` has corresponding tests which simulate typical usage, and they are located in the [`test`](https://github.com/ros2/rcl_logging/tree/master/rcl_logging_spdlog/test) directory.
96+
Each feature in `rcl_logging_spdlog` has corresponding tests which simulate typical usage, and they are located in the [`test`](https://github.com/ros2/rcl_logging/tree/rolling/rcl_logging_spdlog/test) directory.
9497
New features are required to have tests before being added.
9598

9699
Currently nightly test results can be seen here:
@@ -117,7 +120,8 @@ This includes:
117120

118121
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.
119122

120-
Current coverage statistics can be viewed [here](https://ci.ros2.org/job/nightly_linux_coverage/lastSuccessfulBuild/cobertura/src_ros2_rcl_logging_rcl_logging_spdlog_src/). A description of how coverage statistics are calculated is summarized in this page ["ROS 2 Onboarding Guide"](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#note-on-coverage-runs).
123+
Current coverage statistics can be viewed [here](https://ci.ros2.org/job/nightly_linux_coverage/lastSuccessfulBuild/cobertura/src_ros2_rcl_logging_rcl_logging_spdlog_src/).
124+
A description of how coverage statistics are calculated is summarized in this page ["ROS 2 Onboarding Guide"](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#note-on-coverage-runs).
121125

122126
### Performance [4.iv]
123127

@@ -131,7 +135,8 @@ Changes that introduce regressions in performance must be adequately justified i
131135

132136
### Linters and Static Analysis [4.v]
133137

134-
`rcl_logging_spdlog` uses and passes all the standard linters and static analysis tools for a C package as described in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#linters-and-static-analysis). Passing implies there are no linter/static errors when testing against CI of supported platforms.
138+
`rcl_logging_spdlog` uses and passes all the standard linters and static analysis tools for a C package as described in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#linters-and-static-analysis).
139+
Passing implies there are no linter/static errors when testing against CI of supported platforms.
135140

136141
Currently nightly results can be seen here:
137142
* [linux-aarch64_release](https://ci.ros2.org/view/nightly/job/nightly_linux-aarch64_release/lastSuccessfulBuild/testReport/rcl_logging_spdlog/)
@@ -149,21 +154,22 @@ Below are evaluations of each of `rcl_logging_spdlog`'s run-time and build-time
149154

150155
The `rcutils` package provides an API which contains common utilities and data structures useful when programming in C.
151156

152-
It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcutils/blob/master/QUALITY_DECLARATION.md).
157+
It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcutils/blob/rolling/QUALITY_DECLARATION.md).
153158

154159
#### `spdlog_vendor`
155160

156161
The `spdlog_vendor` package provides a CMake shim over the spdlog library.
157162

158-
It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/spdlog_vendor/blob/master/QUALITY_DECLARATION.md).
163+
It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/spdlog_vendor/blob/rolling/QUALITY_DECLARATION.md).
159164

160165
### Optional Direct Runtime ROS Dependencies [5.ii]
161166

162167
`rcl_logging_spdlog` has no optional Direct Runtime ROS dependencies that need to be considered for this declaration.
163168

164169
### Direct Runtime non-ROS Dependency [5.iii]
165170

166-
`rcl_logging_spdlog` has a Direct Runtime non-ROS dependency on the `spdlog` library. It was declared to be Quality Level 1 [here](https://github.com/ros2/spdlog_vendor/blob/master/SPDLOG_QUALITY_DECLARATION.md).
171+
`rcl_logging_spdlog` has a Direct Runtime non-ROS dependency on the `spdlog` library.
172+
It was declared to be Quality Level 1 [here](https://github.com/ros2/spdlog_vendor/blob/rolling/SPDLOG_QUALITY_DECLARATION.md).
167173

168174
## Platform Support [6]
169175

0 commit comments

Comments
 (0)