技術雑記

# git 内の命名規則

git でリポジトリ名やブランチ名はどのような形式で書くのが一般的か気になったので調べた

## まとめ

- ケバブケースが無難そうなので、今後はこの形を使いたい

- スラッシュでのブランチ分類は便利そうなので、利用していきたい

  - ブランチのプレフィクスは、複数人で共有する場合は厳格に規定としておかないと機能しないだろうから、気を付けよう

## 参考 web

- [Qiita] [gitのブランチの命名規則](https://qiita.com/luccafort/items/c91e817e78f1167221cc)

  - branch を必ず issue と連携させる運用をしての報告

  - メリット、デメリット

- [Qiita] [個人的備忘録：チーム開発の難しさと、ブランチの命名規則や運用ルールの決め方についてアウトプットしてみた](https://qiita.com/free-honda/items/c900956445e46c3efbca)

  - プレフィクスの話

  - チケット番号の話

- [Qiita] [ブランチ名に脳死で「/」使ってたらコけた。実は「/」には意味があった話](https://qiita.com/shimauma0322/items/e521afd330271bb41f0f)

  - ブランチ名にスラッシュを使用して失敗した体験談

- [Zenn] [gitリポジトリの命名規則](https://zenn.dev/iwatos/articles/cb79814a4b31ed)

  - GitHub, GitBucket ではURLのリポジトリ名部分の大文字小文字が無視される

- [Git リポジトリ命名規則](https://handbook.geolonia.com/%E7%B5%84%E7%B9%94%E5%88%A5/%E9%96%8B%E7%99%BA/naming-rule-gitrepo.html)

  - あるリポジトリの命名規則 (細かく決めてある)

- [Qiita] [識別子における命名規則の種類について](https://qiita.com/Haaamaaaaa/items/f1c0cd2bcc2b28579f07)

  - git に限った内容ではないが、識別子「～ケース」の種類一覧

## 調査結果

- デファクトスタンダードと呼べるほどの一般論は無い様子

- 以下の理由により、少なくともリポジトリ名はケバブケースが良いとの意見があった

  - GitHub, GitBucket で、URL内のリポジトリ名部分は大文字小文字が無視される

- ブランチ名に関しても、特定の git の命名規則を読むと、ケバブケースを推奨していることが多かった

- 以下の様な意見から、スネークケースよりケバブケースを推す声も

  - アンダースコアよりハイフンが入力しやすい

  - アンダースコアよりハイフンが読みやすい (これは私見だと思うが、同意)

- ブランチには分類としてプレフィクスを親として使用して命名するのが一般的

  - 例 `feature/create-userlogin` `hotfix/modify-window-size`

  - この場合、git の refs 以下に階層として `feature` や `hotfix` ディレクトリが作成されることに留意

    - ※ `feature` というブランチを作成しないように注意 (refs 以下にファイルとして作成されるため、スラッシュ付きのディレクトリと重複して失敗する)

- issue (チケット) と連携している場合は、チケット番号などを明記

  - 例 `feature/#100-add-secure-userlogin`