Skip to content

Conversation

@gavintranquilino
Copy link
Contributor

  • Includes steps for how to add more .msg files to the common_msgs folder.
  • Usage guide to include the common_msgs to existing modules inside their respective Dockerfiles, CMakeLists.txt, and package.xml dependencies
  • Follows the Humanoid Documentation Format/Structure

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces a package-level README for the common_msgs package that documents its structure, purpose, usage guidelines for integration (via Dockerfiles, package.xml, CMakeLists.txt, and code imports), and testing instructions.

  • New README to support adding and using additional message (.msg) files
  • Documentation follows the Humanoid Documentation Format for consistency across the project
Comments suppressed due to low confidence (2)

autonomy/wato_msgs/common_msgs/README.md:21

  • [nitpick] Consider reviewing the bullet list syntax used in the 'Inputs & Outputs' section; using the '-' character for bullets works in markdown but may be confused with diff markers. If possible, consider an alternative bullet symbol or formatting (such as '*' or indenting) to improve clarity for readers.
-   **Outputs**: Provides `.msg` definitions that other ROS 2 packages can import and use.

autonomy/wato_msgs/common_msgs/README.md:25

  • [nitpick] Similarly, in the 'Key Features' section, the use of '-' for bullet points might be mistaken for deletion markers in diff views. Consider using a consistent alternative bullet style to improve readability.
-   **Message Definitions**: Contains a collection of `.msg` files, each defining a specific data structure. These messages are designed to be generic and applicable in multiple contexts.

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.

2 participants