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

Current quality level declarations #67

Merged
merged 7 commits into from Apr 27, 2020

Conversation

brawner
Copy link
Contributor

@brawner brawner commented Apr 16, 2020

This PR adds current quality declarations for both packages as QL 4. With PR #63 and #64 they can almost be QL 3 or even QL 2, but the version will also need to be bumped to 1.0.

Copy link
Contributor

@chapulina chapulina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR. The main thing I think is missing is corroborating evidence for many of the claims. I know linking to some of these things may not be straight-forward. For example, some of the CI links may be too general and not specific to this package.

Until we have a better solution, I think it's best to add the best links we can provide, than no links at all. We need to think of this from the point of view of someone who's not familiar with ROS or this package. They could use some direction to how the claims can be verified.

rosidl_typesupport_c/QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
rosidl_typesupport_c/QUALITY_DECLARATION.md Show resolved Hide resolved
rosidl_typesupport_c/QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
rosidl_typesupport_c/QUALITY_DECLARATION.md Show resolved Hide resolved
rosidl_typesupport_c/QUALITY_DECLARATION.md Show resolved Hide resolved
Copy link
Contributor

@ahcorde ahcorde left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comments can be applied in both QUALITY_DECLARATION.md files

@ahcorde
Copy link
Contributor

ahcorde commented Apr 17, 2020

According with the REP 2004 we need to:

Must have a section in the repository's README which contains the "quality declaration" or links to it*

@brawner
Copy link
Contributor Author

brawner commented Apr 21, 2020

READMEs are being added in #64. To avoid merge conflicts and PR dependencies, I'll add these declaration links to the READMEs after that PR is merged in.

Signed-off-by: Stephen Brawner <brawner@gmail.com>
Signed-off-by: Stephen Brawner <brawner@gmail.com>
Signed-off-by: Stephen Brawner <brawner@gmail.com>
@ahcorde
Copy link
Contributor

ahcorde commented Apr 22, 2020

@Blast545 has added a table with the current status of the QD https://github.com/ros2/rcutils/blob/0f448769ee02bb38231cd7656e9e75dc5939212d/QUALITY_DECLARATION.md

I think it worth it to include it. What do you think about adding a new column with the QD that we are targeting.

Signed-off-by: Stephen Brawner <brawner@gmail.com>
@brawner
Copy link
Contributor Author

brawner commented Apr 23, 2020

Following up on table discussion in slack. I fixed my CI links and added the documentation policy section.

Signed-off-by: Stephen Brawner <brawner@gmail.com>
Copy link
Contributor

@ahcorde ahcorde left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review some comments and links

rosidl_typesupport_c/QUALITY_DECLARATION.md Show resolved Hide resolved
rosidl_typesupport_cpp/QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
rosidl_typesupport_c/QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
Signed-off-by: Stephen Brawner <brawner@gmail.com>
Copy link
Contributor Author

@brawner brawner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe I addressed all your feedback here.

rosidl_typesupport_c/QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
rosidl_typesupport_c/QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
rosidl_typesupport_c/QUALITY_DECLARATION.md Show resolved Hide resolved
rosidl_typesupport_cpp/QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
rosidl_typesupport_cpp/QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
rosidl_typesupport_cpp/QUALITY_DECLARATION.md Show resolved Hide resolved
Copy link
Contributor

@ahcorde ahcorde left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor fixes

rosidl_typesupport_c/QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
rosidl_typesupport_c/QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
rosidl_typesupport_cpp/QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
rosidl_typesupport_cpp/QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
Signed-off-by: Stephen Brawner <brawner@gmail.com>
@ahcorde ahcorde merged commit fbac117 into ros2:master Apr 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants