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