Gitリポジトリの良いファイル命名規則への提案が必要です

Question

私はGitリポジトリでファイル命名規則の提案を探しています。

• リポジトリはにチェックアウトされており、正確に一貫性のある文字の大文字と小文字の区別と文字エンコーディングを持っていない可能性がある、OS年代とロケール設定が異なると、クライアント・マシンからコミットされ、一部の特殊文字に向けた行動。

• リポジトリは、ファイル名のビジネス上の理由のために複数の完全な英語の単語を含まなければならないファイル、例えば、いくつかのファイル名がhome_value、またはhome-value、またはHomeValueではなく、完全な英語の単語はないいくつかの省略形が含まれている必要がありますがありますh_vまたはh-vまたはHVのように認識可能です。

私は潜在的な問題を減らすために、どのような規則をチームに設定すべきか疑問に思っています。慣習の変更や後でファイル命名スタイルを強制する努力は、痛みを伴い、生産性を低下させる可能性があります。早い段階からできるだけ詳細なコンベンションとして準備したいと思います。その後、コードベースを自動的に検証するスチュワートスクリプトを作成することができました。

いくつかの初期thoughtlets：

• 私は単語の区切り FOO-バー＃の使用など

  foo_barは番号の使用_と考えることができ、いくつかの可能なフォーマット規則 - 単語の区切り FooBarの＃利用キャメルケース

  として

• ファイルの一部は、Webサーバー上で配信されるHTMLファイルです。

• 常にASCII文字を使用

• 非ASCII文字はユニコード・コードに変換する必要があり、例えばU+12345

• 常に例えば、小文字を使用しますfoo_barとFoo_Barという2つのファイルの競合を避けるため、Foo_BarまたはFooBarではなく、foo_barです。この可能性のある問題は、上記の完全な英語の単語が固有名詞であり、最初の文字を大文字にする必要があることです。情報がファイル名で失われた場合は、別の方法で保存する必要があります。小文字が常に使用されている場合は

• は、その後、キャメルケースはオプション

• いくつかの完全な英語の単語はそれで-、例えばいくつかの英語の名前を持つことができないので、foo-barスタイルはオプションではないようです。唯一の可能性はfoo_barですか？私は、大文字は固有名詞を収容できるようにする場合は

• 、そして一般的には、ファイル名が

  foo_Bar_FooBar

ですが、それは良いアイデアですか？

Answer 1

唯一の本当の技術的な課題は、Unicodeのファイル名があまりサポートされていないことです。彼らは一般に移植性がなく、いくつかの奇妙な問題を引き起こす可能性があります。もう一つの問題は、Windowsは大文字と小文字を区別せず、UnixベースのOSはそうではないということです。つまり、HomeValueとhomevalueという名前のファイルをMacまたはLinuxコンピュータ上に作成すると、Windowsに移動すると問題が発生します。

私はASCII文字を使用することをお勧めします。大文字と小文字を除いて同じ名前の2つの名前はありません。単語の分離に関しては、スペースはうまくいくはずです。 _または-は、HTTP経由で配信しない限り使用する必要はありません。