commitする場合のコメントってどうしてますか？
多くは、仕様書の各機能名や修正履歴となるように、こまかくドキュメントを入力している現場も多いのではないでしょうか？
僕はcommit時にeditorが立ち上がるのが非常にうざかったので-mオプションでワンラインコメントを心がけてます。
その場合に、ルール付けをしておくと、非常にきれいな履歴が作れるので、個人ルールというよりも、開発チームルールにしてしまうことをオススメします。
commitコメントルール
$ git commit -m '%comment%'
%comment%
sample)
作業:機能名:作業状態:任意コメント
1.作業（修正 or 機能追加 or ETC..）
2.機能名（◯◯機能 or 対象ファイル名）
3.作業状態（Fix or continued or setting）
4.任意コメント（なるべく短く）
git log
履歴は「git log」で確認できますが、
$ git log --oneline
とすると、上記ルールを行っている場合見やすくなったと思います。
機能名などはbranchで分けてもいいし、チーム名や、作業者などを組み込んで独自のルールにしてもいいと思います。
開発規模や、期間によってもルールを変えていくことをオススメします。
・branch
・commit-comment
・tag
などをルール化することで、履歴や作業自体を整理できるし、その後のドキュメントにも十分活かせる仕組みになると思います。
是非、活用あれ。
0 件のコメント:
コメントを投稿