🔖

GitHubのリポジトリ名は小文字+「-」が人気という話

1 min read

概要

  • GitHubのリポジトリ名の命名に悩んだのでちょっと調べてみた。
  • Is there a naming convention for git repositories?
    • sample-repositoryのほうがsample_repositoryよりも人気があるとのこと
  • この辺は後付の理由な気ははするけれど…
  • SEOの利点がある
  • _より-のほうがタイプしやすい

GitHub だとリポジトリ名がそのまま URL の一部として使われるので, URL に使用可能な文字種で命名したほうが良いと思います.
傾向としては感覚ですが, 英小文字で, 単語の間をハイフンで繋ぐ命名が多いと感じます.

プロジェクト名がそのままファイルシステムに展開される場合も多いです.
PascalCase のような命名は, ものによっては大文字小文字を区別できないファイルシステムで問題になるかも知れません.
その為か, 英大文字を使った命名であってもハイフンで繋いでいたりしますね.

  • 人気のリポジトリを見てみると確かにsample-repositoryが多い印象を受ける

GitHubリポジトリのスター数ランキングを表示する - Qiita
image

見やすさ比較

  • ざっとリポジトリ名が並んだときに、確かに前者のほうが視認性が良い気がはする
  • 小文字+-の場合
ikeh-lorem-project
ikeh-ipsum-project
ikeh-dolor-project
ikeh-sit-project
ikeh-amet-project
ikeh-consectetur-project
  • キャメルケースの場合
IkehLoremProject
IkehIpsumProject
IkehDolorProject
IkehSitProject
IkehAmet-project
IkehConsecteturProject

まとめ

  • プログラムの関数・変数名では-は演算子と紛らわしいので全く使わないが、視認性やURLになることを考えると小文字+-のリポジトリ名がいいかな、というのが今の所の結論。