commit メッセージ
明確な commit メッセージを使用すると、pull リクエストのレビューが容易になり、リリースノートの生成も容易になります。Blockly プロジェクトでは、このために慣例的なコミットを使用しています。
各 commit は次の形式にする必要があります。
<type>: <description>
[optional body]
[optional footer(s)]
なお、コア Blockly リポジトリには、このルールを適用するためのコミット リンターがあります。pull リクエストに複数の commit がある場合、リンターはタイトルをチェックします。コミットが 1 つしかない場合は、そのコミットがチェックされます。個々のコミットとプルリクエストのタイトルの両方がこのガイドラインに沿っていることが望ましいです。
タイプ
型は空ではなく、すべて小文字にする必要があります。以下に、受け入れられる型の一覧を示します。
chore- 依存関係のアップグレードなど、ルーティン/自動化されたタスクを完了するコミットの場合。
deprecate- 機能を非推奨にするコミットの場合。
feat- Blockly に新しい機能を追加するコミットの場合。
fix- Blockly のバグやエラーを修正するコミットの場合。
release- 新しいバージョンのリリースに関連するコミットの場合。
破壊的変更
破壊的変更を行うコミットでは、コミットの種類の後に ! を追加する必要があります。互換性を破る変更とは、アプリで Blockly を使用しているデベロッパーのアプリを壊し、追加の作業が必要になる可能性がある変更のことです。
次に例を示します。none
fix!: return type of workspace.paste
互換性を破る変更には、上記の有効な型のいずれかを指定できます。
説明
説明は空にすることはできません。256 文字以内で指定してください。
本文
本文は省略可能です。指定する場合は、説明との間に空白行を 1 行入れる必要があります。256 文字以下の行に分割する必要があります。
通常、この種の情報はコミットに直接記述するのではなく、プルリクエストの説明に記述することをおすすめします。
フッター
フッターは省略可能です。指定する場合は、本文との間に空行を挿入する必要があります。256 文字以下の行に分割する必要があります。
従来の commit 以外の commit を修正する
変更を行う際に慣例的な commit を使用しなかった場合は、commit の数に応じてメッセージを修正する 2 つの方法があります。
pull リクエストに複数のコミットがある場合は、要件に準拠するように pull リクエストのタイトルを編集します。pull リクエストがマージされると、他のコミットはスクワッシュされ、タイトルがコミット メッセージになります。
pull リクエストに commit が 1 つしかない場合は、
git commit --amendを使用して commit メッセージを修正し、変更を Blockly のフォークに強制的に push します。これにより、このブランチに関連付けられている未解決のプルリクエストが自動的に更新されます。git push --force origin my-branch