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

Repo naming #6

Open
mpowelson opened this issue Jan 13, 2020 · 4 comments
Open

Repo naming #6

mpowelson opened this issue Jan 13, 2020 · 4 comments

Comments

@mpowelson
Copy link
Contributor

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
Copy link

gavanderhoorn commented Jan 14, 2020

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
Copy link
Contributor Author

@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
Copy link

gavanderhoorn commented Jan 16, 2020

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
Copy link

@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.

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

No branches or pull requests

3 participants