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

Suggestions: use more specific package names? #28

Closed
traversaro opened this issue Nov 26, 2024 · 5 comments · Fixed by #31
Closed

Suggestions: use more specific package names? #28

traversaro opened this issue Nov 26, 2024 · 5 comments · Fixed by #31
Assignees
Labels
domain-software Related to Software team-fix Related to Team Fix

Comments

@traversaro
Copy link
Member

We can discuss on this in person, but I wanted to mark this down somewhere. I may be wrong, but it seems to me the CMake/ROS 2 packages installed by this repo have quite generic names (for example robot_controller, robot_moveit, test_controller) that may be prone to collisions. Such generic names are fine if they were just folders in a repo (as the name of the repo itself would result in a sort of namespace) but in this case the names are also used to install files in global location.

to avoid this problem, could it make sense to prefix all packages with xcub_moveit2_ ? This is a common pattern in ROS repos that contain multiple ROS packages see for example:

Probably it could make sense to change this before making the repo available in the superbuild (see robotology/robotology-superbuild#1746)?

@traversaro traversaro changed the title Suggestions: use less generic package names? Suggestions: use more specific package names? Nov 26, 2024
@Nicogene Nicogene added team-fix Related to Team Fix domain-software Related to Software labels Nov 27, 2024
@martinaxgloria
Copy link
Member

I started to have a look at the new packages names and I noticed that the standard convention for the ros2/moveit2 packages is <robot_name>_<package_name>, for example this is the panda moveit2 repository.
Maybe it would be better to rely on xcub_ prefix instead of xcub_moveit2_? In this way, we would avoid package names with repetitions such as xcub_moveit2_icub_moveit_config

cc @traversaro @Nicogene

@traversaro
Copy link
Member Author

Ok for me! However, I would try to avoid names like xcub_robot_controller and xcub_test_controller that are a bit generic and do not refer to moveit.

@martinaxgloria
Copy link
Member

What about xcub_ros2_controllers? For the test_controller package, instead, it was used to test the controller performances (see here). So, if we want to avoid the name xcub_test_controller, we could move this folder somewhere else.

cc @traversaro @Nicogene

@traversaro
Copy link
Member Author

What about xcub_ros2_controllers?

Ok, it make sense as it clarify that the package contains controllers for ros2_control.

For the test_controller package, instead, it was used to test the controller performances (see here). So, if we want to avoid the name xcub_test_controller, we could move this folder somewhere else.

What about xcub_ros2_controllers_test or xcub_moveit_test_controller ?

@martinaxgloria
Copy link
Member

PR opened here:

cc @traversaro @Nicogene

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain-software Related to Software team-fix Related to Team Fix
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants