Skip to content

Commit

Permalink
Update QUALITY_DECLARATION to reflect QL 2 status (#260)
Browse files Browse the repository at this point in the history
* Update QUALITY_DECLARATION to reflect QL 2 status

Signed-off-by: Stephen Brawner <brawner@gmail.com>
  • Loading branch information
brawner authored Jun 5, 2020
1 parent 9558a3f commit 4157542
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
17 changes: 9 additions & 8 deletions 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 `rcutils` package, ba

# `rcutils` Quality Declaration

The package `rcutils` claims to be in the **Quality Level 3** category.
The package `rcutils` 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 Quality Categories in REP-2004](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#package-quality-categories) of the ROS2 developer guide.

Expand Down Expand Up @@ -67,11 +67,11 @@ All pull requests must resolve related documentation changes before merging

### Feature Documentation [3.i]

`rcutils` does not have a documented feature list.
`rcutils` has a documented feature list and it is hosted [here](http://docs.ros2.org/latest/api/rcutils/index.html).

### Public API Documentation [3.ii]

`rcutils` does not cover a public API documentation.
`rcutils` has documentation of its public API and it is hosted [here](http://docs.ros2.org/latest/api/rcutils/index.html).

### License [3.iii]

Expand Down Expand Up @@ -114,7 +114,8 @@ This includes:

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/lastBuild/cobertura/src_ros2_rcutils_src/)
Current coverage statistics can be viewed [here](https://ci.ros2.org/job/ci_linux_coverage/lastSuccessfulBuild/cobertura/src_ros2_rcutils_src/).
A description of how coverage statistics are summarized from this page, can be found in the ["ROS 2 Onboarding Guide"](https://index.ros.org/doc/ros2/Contributing/ROS-2-On-boarding-Guide/#note-on-coverage-runs).

### Performance [4.iv]

Expand Down Expand Up @@ -177,15 +178,15 @@ The chart below compares the requirements in the REP-2004 with the current state
|2.iv| CI policy for change requests ||
|2.v| Documentation policy for change requests ||
|3| **Documentation** | --- |
|3.i| Per feature documentation | |
|3.ii| Per public API item documentation | |
|3.i| Per feature documentation | |
|3.ii| Per public API item documentation | |
|3.iii| Declared License(s) ||
|3.iv| Copyright in source files||
|3.v.a| Quality declaration linked to README ||
|3.v.b| Centralized declaration available for peer review ||
|4| Testing | --- |
|4.i| Feature items tests | |
|4.ii| Public API tests | |
|4.i| Feature items tests | |
|4.ii| Public API tests | |
|4.iii.a| Using coverage ||
|4.iii.a| Coverage policy ||
|4.iv.a| Performance tests (if applicable) ||
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Quality Declaration

This package claims to be in the **Quality Level 3** 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.

## API

Expand Down

0 comments on commit 4157542

Please sign in to comment.