-
Notifications
You must be signed in to change notification settings - Fork 1
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
Demo PR for rosdistro-reviewer #24
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for sending a pull request to ROS distro!
This is an automated tool that helps check your pull request for correctness. This tool checks a number of attributes associated with your ROS package and generates a report that helps our reviewers merge your pull request in a timely fashion. Here are a few things to consider when sending adding or updating a package to ROS Distro. ROS Distro includes a very helpful CONTRIBUTING.md file that we recommend reading if it is your first time submitting a package. Please also read the ROS Distro review guidelines which summarizes this release process.
If you'd like to run this tool again to generate a new review for your PR, just re-request review from GitHub Actions.
ROS Distro Considerations
- ROS Distribtutions are created using REP-134 Standards Track as a guide.
- Your package name should comply to REP-144 ROS Package Naming
- Your pacakge must build for all platforms and architectures on the ROS buildfarm. See REP-2000 ROS Releases and Supported Platforms for all supported platforms for your ROS Distro.
- Your package must contain an OSI approved license. Your
package.xml
file must also include that license in a machine readable format. See REP-149 Package Manifest Format Three Specification for additional details. - Your package must include a copyright at the top of every file.
- A publicly available, open source, repository for your ROS package.
- While not required, we recommend that you create an account for ROS Discourse and subscribe to the appropriate release topic.
- If you real time chat would help you resolve an issue please join our [Discord Server] and join the
#infra-help
channel.
Package Considerations
Having your package included in a ROS Distro is a badge of quality, and we recommend that package developers strive to create packages of the highest quality. We recommend package developers review the following resources before submitting their package.
- REP-2004 Package Quality Declaration-- The ROS 2 TGC has created a quality rating system for ROS packages. These ratings should serve as a guide for package developers. We recommend package developers achieve a quality level of three or higher.
- Documentation -- at minimum ROS packages should include an extensive README.md file, and API level documentation using the Sphinx documentation system.
- Maintainer Responsibilities -- the ROS 2 documentation includes a guide to ROS package maintainer responsibilities that summarizes your responsibilities as an open source maintainer.
- Your package should strive to conform to the ROS 2 Developer Guide and the ROS 2 Style Guide.
For changes related to rosdep:
- ✅ New rosdep keys are named appropriately
- ❌ There are problems with explicitly provided platforms:
- One or more explicitly provided platforms are no longer supported
- One or more explicitly provided platforms are not supported by rosdep
For changes related to yamllint:
- ❌ One or more linter violations were added to YAML files
'*': | ||
pip: | ||
packages: [aioraven] # Should migrate to system package someday | ||
archlinux: [python3-aioraven] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This OS is not supported by rosdep
packages: [aioraven] # Should migrate to system package someday | ||
archlinux: [python3-aioraven] | ||
ubuntu: | ||
bionic: [python3-aioraven] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This release is no longer a supported version of ubuntu
@@ -196,6 +196,10 @@ atlas: | |||
macports: [atlas] | |||
rhel: [atlas-devel] | |||
ubuntu: [libatlas-base-dev] | |||
aunit: | |||
fedora: [aunit-devel] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line does not pass YAML linter checks: wrong indentation: expected 2 but found 4
python3-aioraven: | ||
'*': | ||
pip: | ||
packages: [aioraven] # Should migrate to system package someday |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line does not pass YAML linter checks: too few spaces before comment
This PR hasn't been activity in 14 days. If you are still are interested in getting it merged please provide an update. Otherwise it will likely be closed by a rosdistro maintainer following our contributing policy. It's been labeled "stale" for visibility to the maintainers. If this label isn't appropriate, you can ask a maintainer to remove the label and add the 'persistent' label. |
There are a handful of issues with this PR. Ideally, the review automation should give me clear signals that help me quickly discover how to modify my changes so that they can be accepted.