Git：Commitで何か言うことをする方法を教えてください

Githubのトップスターの1つであるプロジェクトを観察したことがあるかどうかはわかりません。すべてのプロジェクトには、完全なドキュメントシステムと高カバレッジのテストケースがあります。完璧を達成するためには、標準がないことは絶対に不可能です。コードにはコード標準が必要であり、コラボレーションには協調標準が必要です。今日お話しするトピックは、Gitでコミットメッセージを記録するためのリファレンス仕様です。まずは有名な国際プロジェクトの写真と、有名な国内プロジェクトの写真の2枚を見てみましょう（笑）。

国際的に有名なプロジェクトAngularJS

ここに画像の説明を挿入

上の2枚の写真から、すでにいくつかの手がかりが見えていると思いますが、どちらが開発を促進できるかは自明です。もちろん、私はこの有名な国内プロジェクトを極端なものとして引用しますが、全体として、コミットメッセージはよりカジュアルです。

コミット仕様

一連の考えに従って、このステップで計画を立てる必要があります。計画は、上記のAngularJSプロジェクトで使用されているGitCommitガイドラインです。

コミットメッセージ形式

<type>(<scope>): <subject>
<空行>
<body>
<空行>
<footer>

上記は、コミット後のメッセージ形式の仕様であり、タイトル、コンテンツの詳細、および終了の3つの部分に分かれています。それぞれに独自の用途があり、追加の項目はありません。

ヘッダーは最初の行で、ページ上で直接プレビューできます。上の図に示すように、3つの部分があり、意味は次のとおりです。

タイプ

feat：新機能（機能）
修正：バグを修正
ドキュメント：ドキュメント
スタイル：フォーマット（コード操作の変更には影響しません）
リファクタリング：リファクタリング（つまり、これは新機能ではなく、バグを修正するためのコード変更でもありません）
テスト：テストを追加
雑用：ビルドプロセスまたは補助ツールの変更

範囲

このコミットの影響の範囲を説明するために使用されます。つまり、変更に関係する部分を簡単に説明するために使用されます。これは元々オプションのアイテムでしたが、実際のAngularJSプロジェクトから、基本的に必須のアイテムになっていることがわかります。

件名

特定の情報は後で本文に記載されるため、この変更を簡単に説明するために使用されます。概要のみです。そして、次の3つに従うのが最善です。

動詞で始まり、変更、変更なし、変更などの一人称現在形を使用します
最初の文字を大文字にしないでください
ピリオドで終わらせないでください（。）

体

ここでの内容は、上記の内容を拡張したものであり、より詳細な説明です。内容には、変更の動機と変更前後の比較を含める必要があります。

元に戻す

さらに、前のコミットをキャンセルする必要がある場合、このコミットメッセージはrevert：最初に始まり、その後に前述のヘッダー部分が続く必要があり、形式は変更されません。さらに、Body部分の形式も固定されており、失効前のCommitのSHA値を記録する必要があります。

練習ツール

上記はAngularJSの現在のCommit仕様です。最初に連絡したときは少し大きくなると思いますが、現時点で、ステップバイステップのリマインダーや視覚的なデモンストレーションがあれば素晴らしいと思います。さて、あなたは正しい場所に来ました。それでは、仕様を実行可能な特定のステップに変える方法について話しましょう！

ツールCommitizをインストールします

これらの仕様を実際の使用に適用するには、Commitizenこのノードツールを使用する必要があります。このツールは、コミットプロセス中に、より標準化されたコンテンツを使用して仕様を段階的に実装する方法を段階的にガイドします。もちろん、このようなものに固有の基準はありません。会社ごとに違いがあります。もちろん、これもツールによって考えられます。独自の仕様をカスタマイズして、Commitizenにフォームの独自の仕様に従うようにすることもできます。プラグインの。思い出させてください。

インストール

npm install -g commitizen

構成

前のステップでは、commitizenをグローバルにインストールしてから、GitリポジトリでCommit仕様を構成できます。プロジェクトを開き、次のコマンドを実行します。

commitizen init cz-conventional-changelog --save --save-exact

上記のcz-conventional-changelogはAngularJS仕様です。他の仕様は、公式Webサイトで自分で見つけることができます。そうでない場合は、時間をかけてコピーを作成してください。このコマンドは、cz-conventional-changelog仕様をダウンロードし、package.jsonを構成し（依存関係を追加し、アプリケーション仕様を構成する）、特定の変更を確認する場合はpackage.jsonを開くのに役立ちます。

使用する

この時点で、インストールが完了した場合でもgit commit、必要に応じてgit czCommitの対話型インターフェイスを指示に置き換えることで呼び出すことができ、上記の仕様の入力方法を段階的に確認できます。方法は明確ではありません。自分でプロジェクトを構築するのに十分です。記事の最後に動画を投稿してクラスメートに会えなかったのは残念です。（追記：転送すると便利だと思います）

また見ることができます：

Git：リベースコマンドについて話します

Git：安全にコミットする方法

Git：「gitpull」操作を適切に実行する方法

Git：「小さなステップと実行」開発モデル

Git：コミットされたファイルを無視します

Git：コミット履歴を書き換える

Git：プロジェクトでサブモジュールを正しく使用する方法