Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update QD to reflect QL 2 statuses. #499

Merged
merged 5 commits into from
Jun 5, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions rosidl_runtime_cpp/QUALITY_DECLARATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ This document is a declaration of software quality for the `rosidl_runtime_cpp`

# rosidl_runtime_cpp Quality Declaration

The package `rosidl_runtime_cpp` claims to be in the **Quality Level 4** category.
The package `rosidl_runtime_cpp` claims to be in the **Quality Level 2** category.

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

Expand Down Expand Up @@ -99,7 +99,17 @@ The BoundedVector class is tested and the most recent test results can be found

### Coverage [4.iv]

`rosidl_runtime_cpp` does not currently track test coverage.
`rosidl_runtime_cpp` 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.

This includes:

- tracking and reporting line coverage statistics
- achieving and maintaining a reasonable branch line coverage (90-100%)
- no lines are manually skipped in coverage calculations

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.

Current coverage statistics can be viewed [here](https://ci.ros2.org/job/ci_linux_coverage/lastSuccessfulBuild/cobertura/src_rosidl_rosidl_runtime_cpp_include_rosidl_runtime_cpp/).
brawner marked this conversation as resolved.
Show resolved Hide resolved

### Performance [4.iv]

Expand Down
2 changes: 1 addition & 1 deletion rosidl_runtime_cpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ The features provided by `rosidl_runtime_cpp` are documented in its [feature doc

## Quality Declaration

This package claims to be in the **Quality Level 4** category, see the [Quality Declaration](QUALITY_DECLARATION.md) for more details.
This package claims to be in the **Quality Level 2** category, see the [Quality Declaration](QUALITY_DECLARATION.md) for more details.
15 changes: 13 additions & 2 deletions rosidl_typesupport_interface/QUALITY_DECLARATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ This document is a declaration of software quality for the `rosidl_typesupport_i

# rosidl_typesupport_interface Quality Declaration

The package `rosidl_typesupport_interface` claims to be in the **Quality Level 4** category.
The package `rosidl_typesupport_interface` claims to be in the **Quality Level 2** category.

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

Expand Down Expand Up @@ -101,7 +101,18 @@ Most recent test results can be found [here](https://ci.ros2.org/job/nightly_lin

### Coverage [4.iv]

`rosidl_typesupport_interface` does not currently track test coverage.
`rosidl_typesupport_interface` 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.

This includes:

- tracking and reporting line coverage statistics
- achieving and maintaining a reasonable branch line coverage (90-100%)
- no lines are manually skipped in coverage calculations

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.

Because this package is a header only library with just C macro definitions, its coverage is not able to be reported.
The unit test of all its macros can be found in the test directory.

### Performance [4.iv]

Expand Down
2 changes: 1 addition & 1 deletion rosidl_typesupport_interface/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ They are available in the `macros.h` header.

## Quality Declaration

This package claims to be in the **Quality Level 4** category, see the [Quality Declaration](QUALITY_DECLARATION.md) for more details.
This package claims to be in the **Quality Level 2** category, see the [Quality Declaration](QUALITY_DECLARATION.md) for more details.