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


328

たとえば、Purchase ServiceというRESTfulなサービスがあります。リポジトリに名前を付けますか?

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

慣習は何ですか?Githubではどうですか?公開リポジトリはいくつかの標準に従うべきですか?


4
このブログの記事は、いくつかの用途があるかもしれないgravitydept.com/blog/...
PHeiberg

回答:


379

私は行くだろうpurchase-rest-service。理由:

  1. 「パーチェスレストサービス」とは?長い連結された単語は理解しにくいです。私はドイツ人です。「Donaudampfschifffahrtskapitänspatentausfüllungsassistentenausschreibungsstellenbewerbung。」

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


151
私は(本当に)理解していませんが、あなたは... auschreibungのSを見逃していませんでしたか...?
Vili

6
@adimauro:ドナウ蒸気船の船長特許のフォームに記入するのは、アシスタントとしてのオープンポジションの申請です。
アーロンディグラ2013年

6
camelCaseを使用しない特別な理由はありますか?特殊文字を使用しないので、これが私の共通項目の命名規則です。
10gistic 2013年

31
@ 10gisticリポジトリ名は、大文字と小文字が区別されない、または小文字に変換される可能性があるURL(たとえばgithub)でよく見られます。このため、キャメルケースはお勧めできません。私はgithubがこれを行うとは思いませんが、それでも保存する方が良いようです。
jdg 2013

19
GitHubの人はハイフンを使用します。habrastorage.org/getpro/habr/post_images/d34/331/a8d/...
airato

72

キャメルケースの問題は、単語の解釈が異なることが多いことです。たとえば、checkinServiceとcheckInServiceです。アーロンの答えに沿って、同じ名前のリポジトリが多数ある場合、オートコンプリートでは、気になるリポジトリを作成した人が大文字と小文字の特定の内訳を使用しているかどうかを常に確認する必要があります。大文字は避けてください。

ダッシュに関する彼のポイントもよく知られています。

  1. 小文字を使用します。
  2. ダッシュを使用します。
  3. 具体的に。後で同様のアイデアを区別する必要がある場合があります。つまり、サービスや休憩サービスの代わりに購入/休憩サービスを使用します。
  4. 一貫している。さまざまなGITベンダーからの使用を検討してください-リポジトリをどのようにソート/グループ化したいですか?

3
あなたの答えは2つの重要な問題に触れていますが、上の答えは触れていません。
Beason、2015年

4
checkinServiceかcheckInServiceかを忘れるよりも、checkin-serviceとcheck-in-serviceのどちらを忘れることが良いですか?
MarredCheese

キャメルケースは、非ネイティブスピーカーにとっても困難です。
Ben Aveling、

48

lowercase-with-hyphens GitHubで最もよく目にするスタイルです。*

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

前者はキーストロークを節約するため、私の好みです。

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


8
ハイフンにはSEOの利点もあります。これは重要な考慮事項ではないかもしれませんが、URLについて話しているので、それは重要です。
Michael Scheper 2017年

12
ハイフンには、別の利点もあります。ハイフンには、下線付きのハイパーリンク(アンダースコアがスペースと間違われやすい)を見つけやすくなります。
Jeroen

1
あなたが言ったようにデータを収集することは難しいですが、私はgithub.com/trending/developersに行って、言及された以前のスタイルのみを見ました:lowercase-with-hyphens
SaTa

21

特定のネーミング選択を優先することなく、git repoは選択した任意のルートディレクトリに複製できることに注意してください。

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

ここでディレクトリにrepo.git複製されmyDirます。

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

そのため、クライアントが自分のやりたいことをすべて実行できる分散環境では、Gitリポジトリの命名規則は実際にはありません。
(リポ ' 'のベアフォームxxx.git用に「」を予約することを除いて) RESTサービスには命名規則がある可能性があります(「REST APIの命名規則ガイドラインはありますか?」と同様)。しかし、それは別の問題です。xxx


4
いい視点ね。ただし、クライアント側でリポジトリ名を修正すると、命名規則があると便利な場合があります。思いませんか?そもそも慣例に従っているのなら、なぜそれを修正するのですか?たぶんメイベンが私に大きな影響を与えたのかもしれません。
エイドリアンM

1
@AdrianM私の要点は次のとおりです。はい、命名規則は便利ですが、GitやGitHubとは関係なく、その特定のリポジトリで何をしたいかとは関係ありません。したがって、あなたの質問への答えは「いいえ、gitリポジトリの命名規則はありません」です。
VonC 2012

8

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


6
この投稿はまばらで、個人的な好みではありませんが、Javaのプロジェクト名はキャメルケースであり、一致には多少の余裕があるという利点についても言及しています。ここでの反対投票が名前の偏りだけではないことは確かですか?
eremzeit

1
同意した。その他の回答ではcamelCaseの短所について説明していますが、Javaの世界では、とにかくキャメルケースの方が優れていると判断するのはまったく妥当です。
Michael Scheper 2017年

11
知識豊富な公共サービスの発表:PascalCaseはcamelCaseではありません。
MarredCheese

0

PHPパッケージの作成を計画している場合は、Packagistに入れて、他のcomposerで使用できるようにすることをお勧めします。Composerには、使用する命名規則としてvendorname/package-name-is-lowercase-with-hyphens

JSパッケージを作成する場合は、npmを使用することをお勧めします。命名規則の 1つパッケージ名の途中で大文字を許可しないことです。

したがって、PHPおよびJS lowercase-with-hyphensパッケージで、GitHub上のパッケージと同じようにcomposerまたはnpmでパッケージを使用して名前を付けることをお勧めします。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.