🐷

コミットメッセージでよく使われる命令形の動詞の例

に公開

追加・変更・削除に関する動詞

  • Add: 新しい機能やファイルを追加する
    例: Add new authentication method
  • Update: 既存のコードやドキュメントを更新する
    例: Update user interface for better UX
  • Upgrade: ソフトウェアやライブラリを新しいバージョンにアップグレードする
    例: Upgrade React to version 17
  • Refactor: コードのリファクタリングを行う
    例: Refactor user authentication module
  • Remove: コードやファイルを削除する
    例: Remove deprecated API endpoints
  • Replace: ある部分を新しい実装で置き換える
    例: Replace custom validation with library function
  • Rename: ファイルや変数の名前を変更する
    例: Rename 'user_id' to 'userID' for consistency

バグ修正・最適化に関する動詞

  • Fix: バグを修正する
    例: Fix issue with user login
  • Correct: エラーや不具合を修正する
    例: Correct typo in README
  • Resolve: 問題やバグを解決する
    例: Resolve merge conflicts
  • Patch: 小さな修正や変更を加える
    例: Patch security vulnerability
  • Optimize: パフォーマンスを最適化する
    例: Optimize SQL queries for better performance
  • Improve: コードや機能を改善する
    例: Improve error handling in API
  • Chore: 機能に直接関係のない小さな修正や変更を加える
    例: Chore: lint警告の解消

ドキュメント・テストに関する動詞

  • Comment: コメントを追加・更新する
    例: Comment: コメントの修正
  • Document: ドキュメントを追加・更新する
    例: Document API usage examples
  • Test: 新しいテストを作成する
    例: Test user authentication flow

その他

  • Configure: 設定ファイルや環境設定を行う
    例: Configure CI/CD pipeline
  • Setup: 初期設定やセットアップを行う
    例: Setup project structure
  • Initialize: プロジェクトや設定を初期化する
    例: Initialize repository with README
  • Enable: 機能を有効にする
    例: Enable logging for debugging
  • Disable: 機能を無効にする
    例: Disable debug mode in production

Discussion