Include much more information in the intro block (#28)

Co-authored-by: kscottz <[email protected]> Co-authored-by: Chris Lalancette <[email protected]> Co-authored-by: Steven! Ragnarök <[email protected]>
ros-infrastructure · Nov 14, 2024 · b95225b · b95225b
1 parent cd74be7
commit b95225b
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 2 deletions.
diff --git a/rosdistro_reviewer/submitter/github.py b/rosdistro_reviewer/submitter/github.py
@@ -16,9 +16,36 @@
 GITHUB_TOKEN_ENVIRONMENT_VARIABLE = EnvironmentVariable(
     'GITHUB_TOKEN', 'Authentication token secret for GitHub')
 
-INTRODUCTION = """Hi there, thanks for contributing to ROS!
+INTRODUCTION = """Thanks for sending a pull request to ROS distro!
 
-This is an automated review generated by the [rosdistro-reviewer tool](https://github.com/ros-infrastructure/rosdistro-reviewer). If you'd like the tool to run again, just [re-request review from GitHub Actions](https://github.com/ros-infrastructure/rosdistro-reviewer?tab=readme-ov-file#running-rosdistro-reviewer-in-github-actions).
+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](https://github.com/ros/rosdistro/blob/master/CONTRIBUTING.md) file that we recommend reading if it is your first time submitting a package.
+Please also read the [ROS Distro review guidelines](https://github.com/rosdistro/rosdistro/blob/master/REVIEW_GUIDELINES.md) which summarizes this release process.
+
+If you'd like to run this tool again to generate a new review for your PR, [re-request review from GitHub Actions](https://github.com/ros-infrastructure/rosdistro-reviewer?tab=readme-ov-file#running-rosdistro-reviewer-in-github-actions).
+
+# ROS Distro Considerations
+* ROS Distributions 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 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.
+* Your package must contain an [OSI approved license](https://opensource.org/licenses). Your `package.xml` file must also include that license in a machine readable format. See [REP-149 Package Manifest Format Three Specification](https://ros.org/reps/rep-0149.html#license-multiple-but-at-least-one) for additional details.
+* 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](https://discourse.ros.org/c/release/16).
+* If you would like, you may join our [Discord Server](https://discord.com/servers/open-robotics-1077825543698927656) and ask questions in 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](https://www.ros.org/reps/rep-2004.html)-- The ROS 2 TSC 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 -- it is recommended that ROS packages 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. While we do not enforce these requirements on package maintainers they should be considered best practices.
+* We recommend that your package should strive to conform to the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Developer-Guide.html) and the [ROS 2 Style Guide](https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Code-Style-Language-Versions.html).
+
+# Need Help?
+
+Please post your questions to [Robotics Stack Exchange](https://docs.ros.org/) or refer to the `#infra-help` channel on our [Discord server](https://discord.com/servers/open-robotics-1077825543698927656).
 
 ---
 

diff --git a/test/spell_check.words b/test/spell_check.words
@@ -3,13 +3,15 @@ apache
 archlinux
 autouse
 bubblify
+buildfarm
 colcon
 committish
 connectionpool
 corge
 debian
 deserialized
 diffs
+distro
 eoan
 filepath
 fixturenames
@@ -34,6 +36,7 @@ mypy
 namedtuple
 noop
 noqa
+opensource
 patchset
 pathlib
 plugin