2012-08-14 228 views
181

たとえば、私は購入サービスと呼ばれるRESTfulなサービスを持っています。私は私のリポジトリgitリポジトリの命名規則はありますか?

  1. purchaserestservice
  2. purchase-rest-service
  3. purchase_rest_service
  4. または何か他のものに名前を付けるべきでしょうか?

規約は何ですか。どのようにギブスで?公共のレポジスは何らかの基準に従うべきですか?

+3

このブログの投稿は、いくつかの使用の可能性がありますhttp://gravitydept.com/blog/devising-a-git-repository-naming-convention – PHeiberg

答えて

209

purchase-rest-serviceとします。理由:

  1. "pur chase rests ervice"とは何ですか?長い連結語は理解しにくい。私は知っている、私はドイツ人だ。 "Donaudampfschifffahrtskapitänspatentausüllungsassistentenausschreibungsstellenbewerbung。"

  2. 「_」はより型が困難である「 - 」

+1

個人的には、これも好きですが、明らかにここの回答に基づいています大会はない...まだ。 –

+78

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

+0

@Vili:はい。修正済み:-) –

17

いかなる特定の命名の選択肢を好むがなければ、Gitのレポはあなたの選択の任意のルートディレクトリにクローニングすることができることを覚えておいてください:

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

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

パブリックリポジトリの命名規則が多少正しくない場合でも、依然としてクライアント側で修正することは可能です。

には、どんなクライアントでも何でもできるクライアントが存在するため、本当にGitリポジトリの命名規則はありません。
(「xxx」レポのフォームの「xxx.git」準備金へ除く)
あり(「Are there any naming convention guidelines for REST APIs?」に類似)RESTサービスの命名規則が、それは別の問題である可能性があります。

+3

良い点。しかし、クライアント側でレポ名を修正すると、命名規則を持つことが有用であることがわかります。あなたは思いませんか?最初の大会でコンベンションに従った場合、なぜそれを修正するのですか?たぶん、メイヴンが私に多くの影響を与えたのかもしれない。 –

+1

@AdrianM私の主張は:はい、命名規則は便利ですが、GitやGitHubとは関係がなく、その特定のリポジトリで何をしたいのかとは関係ありません。あなたの質問に対する答えは "いいえ、gitリポジトリの命名規則はありません"です。 – VonC

4

私はJavaとCのバックグラウンドを表示しているだけかもしれませんが、私はCamelCase(CapCase)を句読点よりも好んでいます。私のワークグループでは、このような名前を使用しています。おそらく、リポジトリに含まれているアプリケーションやサービスの名前と一致しているはずです。

+3

この投稿は疎であり、私の個人的な好みではありませんが、彼はまだJavaのプロジェクト名がラクダのケースであり、合同のいくつかの慰めがあるという利点を言及しています。私たちは、ここのダウンボォートはネーミングバイアスが忍び寄るだけではないことを確信していますか? – eremzeit

+1

合意。その他の答えはcamelCaseの短所を説明していますが、Javaの世界では、とりわけWindowsの世界に無頓着なプロジェクトの場合は、CamelCaseの方が優れていると判断するのが妥当です。 –

28

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

ダッシュについてのヒントもよくお伝えします。

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

あなたの答えは、一番上の答えではない2つの重要な問題に触れています。 –

19

lowercase-with-hyphens私が最も頻繁にGitHubの上に表示スタイルです。*

lowercase_with_underscoresは、おそらく私が見る第二最も人気のあるスタイルです。

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

* Anecdotal;私はデータを収集していません。

+4

ハイフンにもSEOの利点があります。これは重大な考慮事項ではないかもしれませんが、私たちはURLについて話しているので、関連性があります。 –