git存储库有一个命名约定吗?
例如,我有一个称为购买服务的RESTful服务。 我应该命名我的存储库吗?
purchaserestservice
-
purchase-rest-service
-
purchase_rest_service
- 或者是其他东西?
什么是约定? 在github呢? 公共回购应该遵循一些标准吗?
我会去purchase-rest-service
。 原因:
-
什么是“追逐rest服务”? 长而串连的单词很难理解。 我知道,我是德国人。 “Donaudampfschifffahrtskapitänspatentausfüllungsassistentenausschreibungsstellenbewerbung。”
-
“_”比“ – ”更难打字。
骆驼案件的问题是,经常有不同的解释 – 例如checkinService vs checkInService。 与Aaron的答案一起,如果你有很多类似的命名回购,必须经常检查创build回购的人是否使用了大小写的细分,那么自动完成就很困难。 避免大写。
他关于破折号的观点也很好。
- 使用小写。
- 使用破折号。
- 请明确点。 你可能会发现你必须在以后区分类似的想法 – 即使用购买rest服务而不是服务或rest服务。
- 始终如一。 考虑来自各个GIT供应商的使用情况 – 您希望如何对存储库进行sorting/分组?
lowercase-with-hyphens
是我经常在GitHub上看到的风格。*
lowercase_with_underscores
可能是我看到的第二个最stream行的风格。
前者是我的首选,因为它可以节省击键。
*轶事; 我还没有收集任何数据。
不要偏袒任何特定的命名选项,记住一个git repo可以被克隆到你select的任何根目录中:
git clone https://github.com/user/repo.git myDir
这里repo.git
将被克隆到myDir
目录中。
所以,即使你的公共仓库的命名规则稍微有点不正确,仍然可以在客户端修复它。
这就是为什么在分布式环境中,任何客户都可以做任何他想做的事情,Git仓库并没有真正的命名规则。
(除了保留“ xxx.git
”作为回购“ xxx
”的裸机forms)
REST服务可能有一个命名约定(类似于“ 是否有任何关于REST API的命名约定准则? ”),但这是一个单独的问题。
也许这只是我的Java和C背景显示,但我更喜欢CamelCase(CapCase)在名称标点符号。 我的工作组使用这样的名字,可能会匹配存储库包含的应用程序或服务的名称。