web-dev-qa-db-ja.com

Gitリポジトリの命名規則はありますか?

たとえば、Purchase ServiceというRESTfulサービスがあります。自分のリポジトリに名前を付けるべき

  1. purchaserestservice
  2. purchase-rest-service
  3. purchase_rest_service
  4. または、他の何か?

コンベンションは何ですか? githubではどうですか。公開リポジトリは何らかの標準に従うべきですか?

264
Adrian M

私はpurchase-rest-serviceに行きます。理由:

  1. 「追跡追跡サービス」とは何ですか?長い、連結された単語は理解するのが難しいです。私はドイツ人です"Donaudampfschifffahrtskapitänspatentausfüllungsassistentenausschreibungsstellenbewerbung"

  2. "_"は " - "よりも入力が難しい

297
Aaron Digulla

ラクダの場合の問題は、単語の解釈が異なることが多いことです。たとえば、checkinServiceとcheckInServiceです。 Aaronの答えに沿って言えば、あなたが気にしているリポジトリを作成した人が大文字と小文字の特定の内訳を使ったかどうかを絶えずチェックしなければならないのは自動補完では困難です。大文字を避けてください。

ダッシュについての彼の主張もまた賢明です。

  1. 小文字を使用してください。
  2. ダッシュを使用してください。
  3. 具体的に。後で似たようなアイデアを区別する必要があるかもしれません。つまり、serviceやrest-serviceの代わりにpurchase-rest-serviceを使用します。
  4. 一貫している。さまざまなGITベンダーからの使用を検討してください - リポジトリをどのようにソート/グループ化したいですか?
56
Matthew Sandoz

lowercase-with-hyphensはGitHubでよく見かけるスタイルです。*

lowercase_with_underscoresはおそらく私が見て二番目に人気のあるスタイルです。

キーストロークを節約するので前者が私の好みです。

*逸話データを収集していません。

37
Dennis

特定の命名の選択を好まずに、gitレポジトリはあなたが選んだ任意のルートディレクトリにクローンできることを覚えておいてください:

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

ここでrepo.gitmyDirディレクトリにクローンされます。

そのため、パブリックリポジトリの命名規則が少し不正確になっても、クライアント側で修正することは可能です。

だからこそ、分散環境では、どのクライアントでも自分のやりたいことができるのですが、Gitリポジトリの命名規則はありません。
(レポジトリ 'xxx'のベア形式用に "xxx.git"を予約する場合を除く)
RESTサービスには命名規則があるかもしれません( " REST AP​​Iに命名規則のガイドラインがありますか? "に似ています)。それは別の問題です。

19
VonC

たぶんそれは私のJavaとCの背景を示すことだけですが、私は名前の中で句読点よりキャメルケース(CapCase)を好む。私のワークグループはそのような名前を使用しています。おそらくリポジトリに含まれるアプリやサービスの名前と一致させるためです。

7
SteveW