是否存在git存储库的命名约定?

时间:2012-08-14 07:23:42

标签: git github naming-conventions

例如,我有一个名为Purchase Service的RESTful服务。我应该命名我的存储库

  1. purchaserestservice
  2. purchase-rest-service
  3. purchase_rest_service
  4. 或其他什么?
  5. 惯例是什么?在github怎么样?公共回购应遵循一些标准吗?

5 个答案:

答案 0 :(得分:294)

我会去purchase-rest-service。原因:

  1. 什么是“pur chase reststs ervice”?冗长的连词很难理解。我知道,我是德国人。 “Donaudampfschifffahrtskapitänspatentausfüllungsassistentenausschreibungsstellenbewerbung。”

  2. “_”比“ - ”

  3. 更难打字

答案 1 :(得分:56)

驼峰案例的问题在于词语经常有不同的解释 - 例如,checkinService vs checkInService。与Aaron的答案一致,如果您有许多类似名称的回购,必须经常检查创建您关注的回购的人是否使用了大小写的某些细分,自动完成是很困难的。避免大写。

他关于破折号的观点也是明智之举。

  1. 使用小写。
  2. 使用破折号。
  3. 具体。您可能会发现以后必须区分类似的想法 - 即使用购买 - 休息 - 服务而不是服务或休息服务。
  4. 保持一致。考虑来自各个GIT供应商的使用情况 - 您希望如何对存储库进行排序/分组?

答案 2 :(得分:37)

lowercase-with-hyphens是我经常在GitHub上看到的风格。*

lowercase_with_underscores可能是我看到的第二种最受欢迎​​的风格。

前者是我的首选,因为它可以节省击键次数。

*轶事;我没有收集任何数据。

答案 3 :(得分:19)

不支持任何特定的命名选择,请记住可以将git repo克隆到您选择的任何根目录中:

git clone https://github.com/user/repo.git myDir

此处repo.git将被克隆到myDir目录中。

因此,即使您的公开回购的命名约定最终稍微不正确,仍然可以在客户端修复它。

这就是为什么在分布式环境中,任何客户端都可以做任何他/她想做的事情,Git repo没有真正的命名约定。
(为了回复'xxx.git'的形式保留“xxx”除外 可能存在REST服务的命名约定(类似于“Are there any naming convention guidelines for REST APIs?”),但这是一个单独的问题。

答案 4 :(得分:6)

也许只是我的Java和C背景显示,但我更喜欢CamelCase(CapCase)而不是名称中的标点符号。我的工作组使用这样的名称,可能与存储库包含的应用程序或服务的名称相匹配。