search
LoginSignup
86

More than 5 years have passed since last update.

posted at

updated at

【Git】コミットに規約をつくる

【1コミットに1つの対応】

・Aの機能を追加
・Bの機能のバグを修正
・Cの機能を削除

【原則】

1 行目にコミットの全体的説明(タイトル)を 50 字以内で記述
2行目は空白行
3行目以降に変更内容の詳細(何をなぜ)を記述する

(英語の場合、1文字目は必ず大文字にすること)

【1行目の記述フォーマット】

Fix:修正
Add:新規機能(ファイル)追加
Change:仕様変更
Remove:削除(ファイル)

日本語の場合

【Fix】Aboutページのフッターリンクを修正
【Add】ユーザー数を取得する関数を追加

(日本語は複雑な表現が多いので、文頭に英語の表記を含める)

マークアップの場合

【**】ページ名 / 説明 の形にする

【Fix】about / フッターリンクを修正
【Add】contact / 住所の欄を追加

【素晴らしいコミットメッセージを書くための7つのルール】

1、タイトルの後は1行空けて本文を書く
2、タイトルを50字以内におさめる
3、タイトルの文頭を大文字にする
4、タイトルの文末にピリオドを付けない
5、タイトルは命令形で記述する
6、本文は1行あたり72字以内におさめる
7、本文ではどのようにではなく何をとなぜを説明する

【コミットするまでの流れ】

1、ファイルの変更部分を確認する

$ git status

2、差分を確認する

$ git diff

3、indexに登録する

$ git add .

4、自分がインデックスに追加したものが正しいかどうかを再度確認

$ git diff --cached

5、コミットする

$ git commit -m "全体的説明" -m "(空白)" -m "詳細"

6、コミットが追加されているかを確認

$ git log

まとめ

最低限必要な命名が(Add,Fix,Modify,Change,Remove)だと思いました。あとは組織内で拡張させてルールを統一すればいいと思います。

重要なことは チーム内でルール(規約)を統一する ことだという思考です。

【勉強を含めた参考文献】

サルでもわかるGit入門
http://www.backlog.jp/git-guide/
Gitのコミットメッセージ
http://qiita.com/itosho/items/9565c6ad2ffc24c09364
git commit するまえに考えるべき10のこと
http://hiroki.jp/2012/09/05/5523/
Gitでコミットする際の改行方法
http://waterkaktos.com/%E5%82%99%E5%BF%98%E9%8C%B2/git-multiple-comment/
コミットするまでの流れ
https://gist.github.com/kurotaky/5483492
良い Commit Messageを書きましょう(翻訳)
https://gist.github.com/esehara/3160352
Gitのコミットメッセージの書き方
http://postd.cc/how-to-write-a-git-commit-message/
Git Pro
http://git-scm.com/book/ja/v2
Gitを学んでいて「なるほど!」となる瞬間
http://postd.cc/aha-moments-when-learning-git/
Git初心者に捧ぐ!Gitの「これなんで?」を解説します。
http://kray.jp/blog/git-why-explanation/
git pull と git pull –rebase の違いって?図を交えて説明します!
http://kray.jp/blog/git-pull-rebase/
[翻訳] 私のコミットをまとめないで
http://qiita.com/gogotanaka/items/8c55f69120965b077737

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
What you can do with signing up
86