git-commit-messages-example.md

参考: https://anond.hatelabo.jp/20160725092419

書き方

• 最初の文字は大文字にする

「追加した」系

• XXXを追加した
  • Add XXX
• XXXをYYYに追加した
  • Add XXX to YYY

「変更した」系

• XXXを変更した
  • Change XXX （変更した）
  • Update XXX （更新した）
• XXXの代わりに、YYYを使うようにした（取り替えた）
  • Use YYY instead of XXX
• XXXをYYYに置換した
  • Replace XXX by YYY
  • Replace XXX with YYY
• ZZZを、 [XXXから] YYYに変更した
  • Change ZZZ [from XXX] to YYY

「消した」系

• XXXを削除した
  • Remove XXX
• YYYからXXXを削除した
  • Remove XXX from YYY

「移動した」系

• XXXを移動した
  • Move XXX
• ZZZを、 [XXXから] YYYに移動した
  • Move ZZZ [from XXX] to YYY

「直した」系

• XXXを直した（修正した）
  • Fix XXX

「できるようにした」系

• doできるようにした
  • Make it possible to do ... （do = 動詞）
    • (e.g.) Make it possible to close window （ウィンドウを閉じられるようにした）
• XXXに対応した
  • Add support for XXX （XXX = 名詞）
    • (e.g.) Add support for Segwit addresses （Segwitアドレスに対応した）
  • Add support for doing ... （doing = 動名詞）
    • (e.g.) Add support for adding new account （アカウントを追加できるようにした）
• 【上級】 XXXがdoできるようにした
  • Allow XXX to do ... （do = 動詞）
    • (e.g.) Allow users to stop minting （ユーザーがmintingを止められるようにした）

「○○にした」系

• XXXをより良くした（改良した）
  • Improve XXX
  • Make XXX better
• XXXを速くした
  • Make XXX faster
• 【一般形】 XXXを○○にした
  • Make XXX ○○ （○○ = 形容詞の比較級 or 名詞）
    • (e.g.) Make XXX function public （XXX関数をパブリックに）
    • (e.g.) Make title shorter （タイトルを短く）
    • (e.g.) Make error messages more readable （エラーメッセージを読みやすく）

「○○しない」系

• doしないようにした
  • Don't do ... （do = 動詞）
    • (e.g.) Don't show message box before closing （終了前にメッセージボックスを表示しないようにした）