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

Add quality declarations for each package except test_msgs #92

Merged
merged 7 commits into from
Apr 30, 2020

Conversation

brawner
Copy link
Contributor

@brawner brawner commented Mar 20, 2020

This adds a QUALITY_DECLARATION.md for each package that describes aspirationally how it meets quality level 1. Aside from the dependent PRs (#89, #90, #91), this repo does not need further modifications to achieve QL 1 after an API review.

There is one unresolved question regarding the message and service file definitions. It has not been historic practice to include a copyright statement in a message or service definition, which may lead to questions about who retains the copyright for such files considering many were copied over from non-copyrighted message/service file definitions in ROS 1. The QD rep generally requires copyright statements in source files, so this package would be atypical.

Furthermore, since none of the files in these QL 1 packages have copyrighted files, it's unclear what is even under the Apache 2 license and what purpose that license serves for this package.

New commit: b2d5ca1

@brawner
Copy link
Contributor Author

brawner commented Apr 23, 2020

This PR was updated to reflect the current status of each package (4).

@brawner
Copy link
Contributor Author

brawner commented Apr 23, 2020

New commit: b2d5ca1

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.

I reviewed action_msgs QD. The same comments can be applied in the others QD.

Please all review this other PR #91 which is pending to merge this PR

action_msgs/QUALITY_DECLARATION.md Show resolved Hide resolved
action_msgs/QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
action_msgs/QUALITY_DECLARATION.md Show resolved Hide resolved
action_msgs/README.md Outdated Show resolved Hide resolved
Signed-off-by: Stephen Brawner <brawner@gmail.com>
Signed-off-by: Stephen Brawner <brawner@gmail.com>
@brawner brawner force-pushed the quality_declaration branch 2 times, most recently from ea1fb1d to 090b103 Compare April 24, 2020 19:40
@brawner
Copy link
Contributor Author

brawner commented Apr 24, 2020

Ok, I addressed the feedback and applied it to the rest of the quality declarations. This PR has become a bit tricky to review since it depends on #91 and it includes two commits itself. I can squash the two commits here if that would make it easier to review. Otherwise you can see an overall comparison of just this PR here:
brawner/rcl_interfaces@comments_documentation...brawner:quality_declaration

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.

There are some files that require punctuation fixes and other minor fixes

action_msgs/QUALITY_DECLARATION.md Outdated Show resolved Hide resolved
lifecycle_msgs/msg/State.msg Outdated Show resolved Hide resolved
lifecycle_msgs/msg/State.msg Show resolved Hide resolved
lifecycle_msgs/msg/State.msg Show resolved Hide resolved
lifecycle_msgs/README.md Show resolved Hide resolved
lifecycle_msgs/msg/State.msg Outdated Show resolved Hide resolved
lifecycle_msgs/msg/Transition.msg Outdated Show resolved Hide resolved
lifecycle_msgs/msg/TransitionDescription.msg Outdated Show resolved Hide resolved
Signed-off-by: Stephen Brawner <brawner@gmail.com>
Signed-off-by: Stephen Brawner <brawner@gmail.com>

Switch QDs to their QL current-level (4)

Signed-off-by: Stephen Brawner <brawner@gmail.com>
Signed-off-by: Stephen Brawner <brawner@gmail.com>
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.

Same punctuation corrections and a link

composition_interfaces/README.md Outdated Show resolved Hide resolved
composition_interfaces/srv/LoadNode.srv Outdated Show resolved Hide resolved
lifecycle_msgs/msg/State.msg Outdated Show resolved Hide resolved
lifecycle_msgs/msg/State.msg Outdated Show resolved Hide resolved
lifecycle_msgs/srv/ChangeState.srv Outdated Show resolved Hide resolved
lifecycle_msgs/srv/GetAvailableStates.srv Outdated Show resolved Hide resolved
lifecycle_msgs/srv/GetState.srv Outdated Show resolved Hide resolved
action_msgs/msg/GoalStatus.msg Outdated Show resolved Hide resolved
action_msgs/README.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.

Thanks, I believe I addressed your feedback.

action_msgs/README.md Outdated Show resolved Hide resolved
action_msgs/msg/GoalStatus.msg Outdated Show resolved Hide resolved
composition_interfaces/README.md Outdated Show resolved Hide resolved
composition_interfaces/srv/LoadNode.srv Outdated Show resolved Hide resolved
lifecycle_msgs/msg/State.msg Outdated Show resolved Hide resolved
lifecycle_msgs/msg/State.msg Outdated Show resolved Hide resolved
lifecycle_msgs/srv/ChangeState.srv Outdated Show resolved Hide resolved
lifecycle_msgs/srv/GetAvailableStates.srv Outdated Show resolved Hide resolved
lifecycle_msgs/srv/GetState.srv Outdated Show resolved Hide resolved
@brawner
Copy link
Contributor Author

brawner commented Apr 30, 2020

Verifying all ros2 packages build, and I didn't break anything.

Build Status

@brawner
Copy link
Contributor Author

brawner commented Apr 30, 2020

CMake warning is unrelated to this documentation.

@brawner brawner merged commit f5b4ab3 into ros2:master Apr 30, 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

2 participants