Include much more information in the intro block #28
Conversation
Co-authored-by: kscottz <[email protected]>
| # ROS Distro Considerations | ||
| * ROS Distribtutions are created using [REP-134 Standards Track](https://ros.org/reps/rep-0143.html) as a guide. | ||
| * Your package name should comply to [REP-144 ROS Package Naming](https://www.ros.org/reps/rep-0144.html) | ||
| * Your pacakge must build for all platforms and architectures on the ROS buildfarm. See [REP-2000 ROS Releases and Supported Platforms](https://www.ros.org/reps/rep-2000.html) for all supported platforms for your ROS Distro. |
There was a problem hiding this comment.
| * Your pacakge must build for all platforms and architectures on the ROS buildfarm. See [REP-2000 ROS Releases and Supported Platforms](https://www.ros.org/reps/rep-2000.html) for all supported platforms for your ROS Distro. | |
| * Your package must build for all platforms and architectures on the ROS buildfarm. See [REP-2000 ROS Releases and Supported Platforms](https://www.ros.org/reps/rep-2000.html) for all supported platforms for your ROS Distro. |
There was a problem hiding this comment.
Actually, this isn't entirely true. We allow packages that build for Ubuntu but not RHEL. But also the spelling error :P
There was a problem hiding this comment.
Spelling fixed in f4f160f, but I'm still not sure how best to word this.
|
|
||
| * [REP-2004 Package Quality Declaration](https://www.ros.org/reps/rep-2004.html)-- 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](https://docs.ros.org/en/rolling/How-To-Guides/Documenting-a-ROS-2-Package.html). | ||
| * Maintainer Responsibilities -- the ROS 2 documentation includes a guide to [ROS package maintainer responsibilities](https://docs.ros.org/en/rolling/How-To-Guides/Core-maintainer-guide.html) that summarizes your responsibilities as an open source maintainer. |
There was a problem hiding this comment.
The guidelines there I believe are for ROS 2 core maintainers rather than community package maintainers. As long as there's nothing too controversial in there they should be applicable but I don't know that they're for all maintainers by design.
There was a problem hiding this comment.
We could add a little disclaimer that they're not enforced outside of the core team, but we consider it best practices.
Co-authored-by: Chris Lalancette <[email protected]>
Co-authored-by: Chris Lalancette <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #28 +/- ##
==========================================
- Coverage 87.66% 87.51% -0.15%
==========================================
Files 13 13
Lines 689 689
Branches 180 169 -11
==========================================
- Hits 604 603 -1
Misses 64 64
- Partials 21 22 +1 ☔ View full report in Codecov by Sentry. |
Demo: cottsay/rosdistro#24
It might be nice to clean up some of the heading/bolding to make things a little more cohesive.