git存储库有命名约定吗?

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

  1. purchaserestservice
  2. purchase-rest-service
  3. purchase_rest_service
  4. 还是别的什么?

惯例是什么?Github呢?公共存储库是否应该遵循某种标准?

321301 次浏览
小开
最佳答案

我选purchase-rest-service。原因:

  1. 什么是“追逐休息服务”?长而连在一起的单词很难理解。我知道，我是德国人。“Donaudampfschifffahrtskapitanspatentausfullungsassistentenausschreibungsstellenbewerbung。”

  2. “_”比“-”更难打

小开

在不偏爱任何特定的命名选择的情况下，请记住git repo可以克隆到您选择的任何根目录:

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

这里repo.git将被克隆到myDir目录中。

因此，即使您的公共回购命名约定最终略有错误，仍然有可能在客户端进行修复。

这就是为什么在分布式环境中，任何客户端都可以做任何他/她想做的事情，Git repo并没有真正的命名约定 (除了为回购'xxx'的裸露的形式保留"xxx.git")
REST服务可能有命名约定(类似于"有没有REST api的命名规范指南?")，但这是另一个问题
小开

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

小开

驼峰情况的问题是，单词通常有不同的解释——例如，checkinService和checkinService。按照Aaron的回答，如果你有许多类似名称的回购，那么自动补全是很困难的，因为你必须不断检查创建你所关心的回购的人是否使用了某种大小写的分解。避免大写。

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

  1. 用小写。
  2. 使用破折号。
  3. 要具体。稍后你可能会发现你必须区分相似的概念，比如用“购买-休息-服务”而不是“服务”或“休息-服务”。
  4. 是一致的。考虑一下不同GIT供应商的使用情况——您希望您的存储库如何排序/分组?
小开

lowercase-with-hyphens是我在GitHub上最常看到的样式

lowercase_with_underscores可能是我看到的第二受欢迎的样式。

前者是我的首选，因为它节省了按键。

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

小开
如果你计划创建一个PHP包，你很可能想把它放在Packagist中，使它可供其他with composer使用。 Composer有命名约定来使用vendorname/package-name-is-lowercase-with-hyphens。< / p >

如果你计划创建一个JS包，你可能会使用npm。它们的命名约定之一是不允许在包名中间使用大写字母。

因此，我建议PHP和JS包使用lowercase-with-hyphens，并在composer或npm中命名与GitHub上的包相同的包。


提交答案