コミットについて

概要

ここでは、Githubでのコミットについて説明する。

まず、commitとは、何かを約束し、実行する行為や、特定の行動や行事を実施することを指す英単語である。

Githubでのコミットとは、コードの変更をバージョン管理システムに記録する行為を指す。
これにより、コードやプロジェクトファイルに対する変更を行った後、これらの変更をバージョン管理システムに”コミット”する。

コミットは、コミットメッセージを添えて、変更内容を説明する。

コミットする理由

コミットする理由として、ある機能を作成したときに仕様変更などでさくせいした機能がいらなくなったとする。
そうした場合に、その変更履歴をさかのぼるためにコミットする。

詳細

コミットは、コードの差分を記録する。

Transclude of コミットの詳細図

動作

ターミナルからのコミット

ターミナルなどからcommitする場合には、このように打つ。

git commit -m 'ここにコミットメッセージを書く'

エディタからのコミット

VScodeなどのエディタからもコミットすることが出来る。
ファイルをステージングしてから、上部の入力欄にコミットメッセージを入力してからボタンをクリックするとコミットすることが出来る。

コミットした結果

その結果としてこのように、コミットが累積していく。
コミットには、コミットメッセージを付随する。

コミットの粒度について

コミットの粒度とは、どのくらいコードを書いたらコミットするかというような話である。
コミットの粒度は個人の裁量に委ねられていたり、チームとしてルールが決まっている場合がある。
基本的には、ある関数を作成した…という場合ではなく、一つの機能が完成したタイミングでコミットするのが望ましい。

Transclude of コミット粒度について

コミットとissueの紐付け

IDでの追跡と管理

イシューは、#作られた順番で管理されており、コメントやコミットの際に#1などとつけると#1に対応したイシューへのリンクが作成される。

上記の画像では、コミットからイシューの内容が表示されている。
このようにしてイシューとコミットを紐づけすることが出来る。

元記事へのリンク