initial draft of the quality declaration #566
Conversation
Signed-off-by: William Woodall <[email protected]>
|
|
||
| ## Change Control Process | ||
|
|
||
| TODO fix link |
There was a problem hiding this comment.
|
|
||
| `rcl` uses `semver` according to the recommendation for ROS Core packages in the [ROS 2 Developer Guide](https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#versioning), and is at or above a stable version, i.e. `>= 1.0.0`. | ||
|
|
||
| ### API Stability Within a Released ROS Distribution |
There was a problem hiding this comment.
These are also part of the Versioning section of the developer guide. It's probably best to just link there and reduce duplication here.
| - all pull request must pass CI on all [tier 1 platforms](https://www.ros.org/reps/rep-2000.html#support-tiers) | ||
| - all pull request must resolve related documentation changes before merging | ||
|
|
||
| ## Documentation |
There was a problem hiding this comment.
Could link to the documentation guidelines common to all packages: https://index.ros.org/doc/ros2/Contributing/Developer-Guide/#documentation
|
|
||
| ### Linters and Static Analysis | ||
|
|
||
| TODO fix link |
There was a problem hiding this comment.
|
|
||
| `rcl` supports all of the tier 1 platforms as described in [REP-2000](https://www.ros.org/reps/rep-2000.html#support-tiers), and tests each change against all of them. | ||
|
|
||
| TODO make additional statements about non-tier 1 platforms? |
There was a problem hiding this comment.
I'd just leave this out of the 1st version. Let's focus on what's needed to get a valid QD in.
|
|
||
| ### Coverage | ||
|
|
||
| TODO fix link |
There was a problem hiding this comment.
|
This pull request has been mentioned on ROS Discourse. There might be relevant details there: https://discourse.ros.org/t/rfc-rep-2004-package-quality-categories/13150/1 |
|
Close in favor of #639 |
This is a quality declaration for
rclas described in the proposed REP-2004 (see ros-infrastructure/rep#218).This declaration is aspirational, in that it states things which aren't currently true, but we plan to do soon so we can get it up to the highest level. I'll use it as a kind of TODO list for fixing up
rcl, using line comments to keep track of progress of certain tasks.This will most likely continue to evolve with the REP as well.