コミットメッセージ
手順
git diff --staged を実行して、何がコミットされるかを確認します。何もステージされていない場合は、その旨を伝え、すべてをステージするか(git add -A)、特定のファイルをステージするかを尋ねます。確認なしにステージされていない作業をコミットしてはいけません。
git log --oneline -15 を実行し、見られるスタイル(Conventional Commits: feat(api): …、チケットプレフィックス: ABC-123 …、または平文)に合わせます。明確な規約がない場合は、平文の命令形を使用します。
- ステージされた変更に複数の無関係な処理が含まれている場合は、それらを別々のコミットに分割することを提案し、すべてに対する1つのメッセージを書くのは避けます。
フォーマット
<要約行、命令形、最大約72文字、末尾にピリオドは付けない>
<本文:変更を行った理由や、差分からは読み取れないレビュアー向けの情報。
72文字で折り返します。些細な変更では本文は省略しても構いません。>
<トレーラー:Fixes #123、Co-authored-by: …、BREAKING CHANGE: …>
- 命令形:「Add retry to upload」(追加した、追加する、ではない)。
- 要約行は、どのファイルが変更されたかではなく、ユーザーまたはコードベースにとって何が変更されたかを示します。
- 本文はなぜを説明します:バグ、制約、却下した代替案など。差分はすでに何を示しています。
- Conventional Commitsを使用する場合、タイプを正直に選びます:
feat(新しい動作)、fix(バグ)、refactor(動作変更なし)、perf、docs、test、build、ci、chore。破壊的変更は!とBREAKING CHANGE:トレーラーでマークします。
例
fix(auth): refresh the token before it expires, not after
Requests made in the last 30 seconds of a token's life failed with 401
because the refresh only ran on the first failure. Refresh when less than
60 seconds remain instead.
Fixes #482
Remove unused CSV export endpoint