Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Is there a naming convention for git repositories?

For example, I have a RESTful service called Purchase Service. Should I name my repository:

  1. purchaserestservice
  2. purchase-rest-service
  3. purchase_rest_service
  4. or something else?

What's the convention? How about in Github? Should public repositories follow some standard?

like image 349
Adrian M Avatar asked Aug 14 '12 07:08

Adrian M


People also ask

Should GitHub repo names be lowercase?

Naming. Use lowercase for repository, directory, and file names. For R-related files, use uppercase R .


2 Answers

I'd go for purchase-rest-service. Reasons:

  1. What is "pur chase rests ervice"? Long, concatenated words are hard to understand. I know, I'm German. "Donaudampfschifffahrtskapitänspatentausfüllungsassistentenausschreibungsstellenbewerbung."

  2. "_" is harder to type than "-"

like image 115
Aaron Digulla Avatar answered Oct 16 '22 12:10

Aaron Digulla


The problem with camel case is that there are often different interpretations of words - for example, checkinService vs checkInService. Going along with Aaron's answer, it is difficult with auto-completion if you have many similarly named repos to have to constantly check if the person who created the repo you care about used a certain breakdown of the upper and lower cases. avoid upper case.

His point about dashes is also well-advised.

  1. use lower case.
  2. use dashes.
  3. be specific. you may find you have to differentiate between similar ideas later - ie use purchase-rest-service instead of service or rest-service.
  4. be consistent. consider usage from the various GIT vendors - how do you want your repositories to be sorted/grouped?
like image 35
Matthew Sandoz Avatar answered Oct 16 '22 12:10

Matthew Sandoz