Git Style Guide - Gitを10倍効果的に使いこなすためのスタイルガイド

Agis git style guide

モダンなバージョン管理ツールとして世界的な人気となっている「Git」。「Git Style Guide」は、そのGitを、さらに有効に使いこなすためのさまざまな推奨スタイルをリストアップした技術ドキュメントです。

同ドキュメントは、主にブランチの作成方法(命名方法)や、コミット方法、コミットメッセージの書き方、マージ方法などに関するより良いスタイルを解説しています。

ブランチの命名

例えばどんな名前を使えば良いのか迷いやすい「ブランチ名」に関しては、漠然とした名前ではなく、具体的で分かりやすい名前を使うことを推奨しています。

# good
$ git checkout -b oauth-migration

# bad - too vague
$ git checkout -b login_fix

チケット管理システムを使っている場合は、そのチケット番号を使ってもよし。

# GitHub issue #15
$ git checkout -b issue-15

単語の区切りはダッシュを使うこと。同じ機能に関して、複数人で作業している場合はスラッシュを使ったブランチ名を使うこと、などが推奨されています。

$ git checkout -b feature-a/master # team-wide branch
$ git checkout -b feature-a/maria # Maria's branch
$ git checkout -b feature-a/nick # Nick's branch

ブランチ以外に関しても、コミットは論理的なまとまりで行うこと、コミットメッセージはターミナルを使わずエディタで書くこと、履歴はシンプルに保つことなど、Gitを使いこなす上でヒントになりそうなこ情報がたくさん記載されています。Gitをさらに有効に使いこなしたい方は参照してみてはいかがでしょうか。

スポンサーリンク