git仓库有命名约定吗?

m4pnthwp  于 2023-02-20  发布在  Git
关注(0)|答案(6)|浏览(140)

例如,我有一个名为Purchase Service的REST风格的服务,我应该将存储库命名为:

  1. purchaserestservice
  2. purchase-rest-service
  3. purchase_rest_service
    1.还是别的什么
    GitHub的惯例是什么?公共仓库应该遵循一些标准吗?
z4bn682m

z4bn682m1#

我选purchase-rest-service。理由:
1.什么是“pur chase rest service”?冗长的连词很难理解。我知道,我是德国人。“Donaudampfschifffahrtskapitänspatentausfüllungsassistentenausschreibungsstellenbewerbung”。
1.“_”比“-”更难键入

m3eecexj

m3eecexj2#

Camel 式大小写的问题在于,单词的解释往往不同--例如,checkinService和checkInService。与Aaron的答案沿着,如果你有许多名称相似的回购协议,那么自动完成就很困难,你必须不断检查创建你关心的回购协议的人是否使用了某种大小写分类。避免使用大写。
他关于破折号的观点也很明智。
1.使用小写。
1.使用破折号。
1.具体一点。你可能会发现你以后必须区分类似的概念--即用购买-休息-服务代替服务或休息-服务。
1.保持一致。2考虑不同GIT供应商的使用情况--你希望你的仓库如何分类/分组?

gk7wooem

gk7wooem3#

lowercase-with-hyphens是我在GitHub上最常看到的风格。*
lowercase_with_underscores可能是我看到的第二流行的风格。
前者是我的首选,因为它节省击键。

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

ggazkfy84#

不要偏爱任何特定的命名方式,记住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?“),但这是一个单独的问题。

9nvpjoqh

9nvpjoqh5#

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

mfpqipee

mfpqipee6#

如果你打算创建一个PHP包,你很可能想把它放在Packagist上,让其他composer可以使用它。Composer有一个命名约定,使用vendorname/package-name-is-lowercase-with-hyphens
如果你打算创建一个JS包,你可能会想使用npm。他们的naming conventions之一是不允许在你的包名中间使用大写字母。
因此,我建议PHP和JS包使用lowercase-with-hyphens,并在composer或npm中将包命名为与GitHub上的包相同的名称。

相关问题