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

  • 英語で書く
  • 命令形 (imperative mood) / 原形不定詞 (bare infinitive) で書く
Imperative mood:
“spoken or written as if giving a command or instruction”
命令形
命令や指示を与えるかのような形式

参考:

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

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

How to Write a Git Commit Message | Chris Beams

概要

  • コミットメッセージの1行目にはピリオドを付けない (件名に相当)
  • バックアップファイルは含めない (.gitignore で不要ファイルを含めない設定をする)
  • コメントアウトした不要コード (変更前のコード) をコミットしない

参考:

git commit するまえに考えるべき10のこと | Act as Professional

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

コミットメッセージの書き方 | ククログ

Git でより良いコミットメッセージを書く方法 | yu8mada

誰にとってもわかりやすい Git のコミットメッセージを考える | Tips Note by TAM

英文

  • Add …
  • Change … to …
  • Remove … (from …)
  • Move … (from …) to …
  • Rename …
  • Fix …
  • Update …
  • Convert … to …
  • Support …

参考:

git におけるコミットログ/メッセージ例文集100 – GitHub Gist

GitHub で使われている実用英語コメント集 – Qiita

プレフィックス

AngularJS 式

  • feat: A new feature 新しい機能
  • fix: A bug fix バグの修正
  • docs: Documentation only changes ドキュメントの変更
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) コーディングスタイルの変更
  • refactor: A code change that neither fixes a bug nor adds a feature リファクタリング
  • perf: A code change that improves performance パフォーマンスの改善
  • test: Adding missing or correcting existing tests テストの追加・修正
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation 雑多な変更 (ツールの追加・修正、雑用的な修正など)

参考:

コミットメッセージに 「プレフィックス」 をつけるだけで、開発効率が上がった話 – Qiita

Type – angular.js/DEVELOPERS.md at master · angular/angular.js – GitHub

アンチパターン

参考:

コミットメッセージアンチパターン コメント対応 | koic の日記

タグ:

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です