シェア:
){kind=small}
マイケル・クランプはVonageのデベロッパーエクスペリエンスチームに所属し、コーダー、YouTuber、そして様々な.NETやクラウド/通信開発トピックについて頻繁に講演を行っています。彼は、開発者がそれぞれの利点を分かりやすく理解できるようにすることに情熱を注いでいます。
優れた Git コミットメッセージの書き方
所要時間：1 分
Git のコミットメッセージを効果的に作成することで、コラボレーションやコードの読みやすさ、プロジェクトの保守性を何年にもわたって大幅に向上させることができます。しかし、開発プロセスでは見落とされたり後回しにされたりしがちです。このブログ記事では、本題に入り、すべての開発者が守るべき、優れた Git コミットメッセージを書くための重要な原則を概説します！
コミットメッセージには、このコミットが何をするのかを明確に記述しなければなりません。読みやすく保守しやすくするために、先頭に大文字の命令形動詞を使いましょう。
例
追加ユーザーログインの新機能
修正支払い処理のバグ
更新APIエンドポイントのドキュメントを更新
コミットメッセージは、コミットの目的を伝えるのに十分な説明的なものでなければなりません。件名は50文字程度を目安にし、本文で詳細を説明しましょう。
良いコミットメッセージ ユーザー認証モジュールのリファクタリング
不正なコミット・メッセージパフォーマンスと可読性を改善するためにユーザー認証モジュールをリファクタリングした。
コミットメッセージの詳細が必要な場合は、本文を追加してください。読みやすくするために、要約と本文の間に空白行を入れるようにしましょう。
アプリケーションのパフォーマンスを向上させるローカルキャッシュの追加
この変更により、ローカル・キャッシュ・メカニズムが実装され、データベースの負荷が軽減され
し、ネットワーク上での全体的な応答時間を改善します。キャッシュは10分ごとに無効化され、データの鮮度を確保します。
標準的な慣習を念頭に置き、コミットメッセージは命令形ムードで書く。これは、コミットが適用されたときに何が行われるかを指示するものです。
例を挙げよう：
正しい： ユーザー認証 ユーザ認証
不正解： 追加された ユーザー認証
修正 修正 ユーザ認証
正しくない： 修正済み ユーザー認証
訂正 更新 ユーザー認証
不正解 更新 ユーザー認証
本文では、コミットについての詳細を説明します。何が行われ、なぜそれが行われたのかを説明します。こうすることで、他の人や将来の自分が、変更の背景や理由を理解しやすくなります：
何:認証ロジックのリファクタリング
なぜか？:パフォーマンスを向上させ、コードの重複を減らす
例
認証ロジックのリファクタリング
パフォーマンスを改善し、コードの重複を減らすために、認証ロジックをクラスから別のモジュールに抽出しました。この変更により
により、将来的な機能拡張の実装が容易になります。
コミットに複数の変更が含まれている場合は、箇条書きにします。こうすることで、それぞれの変更を読みやすく、理解しやすくなります：
決済処理におけるエラー処理の改善
- 支払い入力フィールドのバリデーション追加
- リトライ機能によるAPIエラーの処理
- デバッグのための詳細なエラーメッセージのログ
コミットによって特定の課題やタスクが解決したり関連したりする場合は、プロジェクト管理システム（GitHub IssuesやJiraなど）でそれを参照しましょう。こうすることで、課題のステータスを常に最新の状態に保つことができますし、後で読む人にとっても文脈がとても役に立つでしょう。
不正な合計計算を修正 (#4342)
注文合計の計算ロジックを修正しました。
税金と割引が適用されるようにしました。
コミットしてリポジトリにプッシュする前に、少し時間をとってメッセージを見直しましょう。スペルミス、文法の間違い、わかりやすさをチェックしましょう。よく書かれたコミットメッセージは、プロフェッショナリズムと細部への注意を反映します。
大文字にする 件名を大文字で始めていますか？
簡潔に：件名は50文字以内ですか？
空白行：本文がある場合、要約の後に空白行を追加しましたか？
命令ムード：メッセージは命令法か？
詳細：本文（ある場合）は、何を、なぜ、どのように説明しているか。
リスト リストには箇条書きを使いましたか？
参考文献関連する問題やPRを参照しましたか？
校正：わかりやすさや誤字脱字をチェックしましたか？
Git のコミットメッセージをうまく書くことで、共同作業やプロジェクトの保守性を高めることができます。命令形の動詞を使う、主語を簡潔にする、「何を」「なぜ」を説明する、関連する課題を参照する、といったシンプルなガイドラインに従うことで、ナビゲートしやすく理解しやすい貴重なプロジェクト履歴を作ることができます。また、次のような記事もあります。"従来のコミットを使うべき3つの理由" という記事もあります。
へのご参加もお待ちしております。 VonageコミュニティSlackに投稿してください。 Xをお送りください。お読みいただきありがとうございました！
おめでとう！