search

swri-robotics / toolpath_offline_planning

GUI tools for generating tool paths from mesh models offline
27 stars 18 forks source link

Repo naming #6

Open mpowelson opened 4 years ago

mpowelson commented 4 years ago

It looks like this repo got renamed. Should these pkgs be top_msgs, etc instead of opp_msgs?

Also, should this be Toolpath-Offline-Planning, toolpath-offline-planning, or toolpath_offline_planning. It seems we have repos in all of these formats across the various organizations.

gavanderhoorn commented 4 years ago

Suggestions from an outsider: don't use uppercase characters in repository names.

Best practice in ROS is to use lowercase for everything, except when code styles require otherwise (ie: classnames, etc) and underscores for spaces. No dashes.

So: toolpath_offline_planning.

Although it's a bit of a bland name tbh ;) It also doesn't seem to describe the project completely (for what is this planning? In what context? Why? With what? Etc).

edit: clarify dashes vs underscores.

mpowelson commented 4 years ago

@marip8 @jrgnicho @DavidMerzJr

Could we rename this to at least toolpath_offline_planning? I imagine it isn't hard for someone with the appropriate permissions, and it is going to become more invasive the more we use it, send people links, etc.

Also, should I change the packages to top_package? Just want to make sure this is permanent before I go to the effort.

gavanderhoorn commented 4 years ago

it is going to become more invasive the more we use it, send people links, etc.

Github will forward old links to whatever the repository gets renamed to, so this is not an issue.

(not saying that changing it early on is not a good idea, just wanted to clarify that technically, it's not a problem)

DavidMerzJr commented 4 years ago

@mpowelson opp was a temporary name while we tried to think of something better. When I realized that the repo name spelled T.O.P., I actually thought that was a great name. (Who doesn't love tops?) If you renamed everything to top_, I would fully support that change. (I would also fully support having an icon/logo with a robot spinning a top, or a ROS turtle spinning upside down.)

I also second renaming to lower-case toolpath_offline_planning. The capital letters drive me crazy when trying to tab-complete on the command line. And per @gavanderhoorn, it would be more in line with the ROS ecosystem.