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

Sorts and adds more projects using Gazebo. #570

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

bperseghetti
Copy link
Member

@bperseghetti bperseghetti commented Jan 29, 2025

Summary

Fairly sorts the projects in alphabetical order and highlights tools used to help create new integrations.

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

@bperseghetti bperseghetti requested a review from azeey as a code owner January 29, 2025 17:41
projects_using_gazebo.md Outdated Show resolved Hide resolved
@@ -4,27 +4,31 @@ This is an incomplete list of projects that use (modern) Gazebo. It includes
plugins, examples, ROS integrations, etc. If you'd like to add your project,
please open a pull request by clicking on the "Edit on Github" link.

## Gazebo Plugins
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we want to keep the "Gazebo Plugins" section? I was hoping it would encourage people to add items.

Copy link
Member Author

Choose a reason for hiding this comment

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

This sorta fits into a grey area IMO, the difference from tightly coupled integrations with transport vs "plugin" seems that it might be an overly specific delineation for very similar end user experience? Considering it had no entries (yet)... I think at least showing how to start a project with a template to me is a meaningfully delineable item.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry, I wasn't opposed to the new "Gazebo tools for Integration" subsection. Just asking if we should still keep the "Gazebo Plugins" subsection as well, even though it's empty.

Copy link
Member Author

Choose a reason for hiding this comment

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

I would personally vote to only do it by project and not delineate the way or method, but let people follow the links to see the integration method instead.

Copy link
Contributor

Choose a reason for hiding this comment

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

I would disagree. More structure (to a reasonable degree) would make it easier to find things. The section below is specifically for Gazebo and ROS 2 integration. If the project is a standalone plugin that implements a specific functionality, e.g. model interaction forces between diple magnets (https://github.com/vustormlab/storm_gazebo_ros_magnet from my grad school days 😉 ), I think it would be nice to highlight it in a separate section since users might be able to use it immediately in their own projects.

@bperseghetti bperseghetti force-pushed the pr-sorta_and_add_projects branch from 2f6be13 to 25e6276 Compare January 29, 2025 18:04
@bperseghetti bperseghetti requested a review from azeey January 29, 2025 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Inbox
Development

Successfully merging this pull request may close these issues.

2 participants