コミットメッセージの書き方

基本的な方針

• コミットメッセージはgit log --onelineした時に（1行だけで表示した時に）作業内容が分かるように意識する
  • 細かい説明や、その実装にした理由などはgithubのissueに書く
• github上からissueをたどりやすいように、issue番号でリンクさせる

フォーマット

1行目　[{status}] refs|closes #{issue number} {commit message}
2行目　空行
3行目　追記したいことがあれば書く

基本的には1行目だけでOK。

Tips

コミットに closes #{issue_number} というワードを入れておくと、pushした時に勝手にissueを閉じてくれる。便利。

statusの種類

• [wip] 途中コミット work in progress
• [add] 機能追加
• [fix] バグ修正
• [mod] バグじゃない修正 modify
• [cln] リファクタリング、ファイル整理 clean
• [rvt] 変更取り消し（pushしたコミット履歴は改変しない方向で...）revert

このへんは適宜追加・削除する。誰か詳しい人いい運用教えてください。

参考

• Gitのコミットメッセージの書き方

• コミットログお作法の資料

まぁ状況に応じて話して決めていきましょう。