| name | commit-style |
| description | Commit message style guidelines. Use when writing or proposing git commit messages, including direct git commit commands outside the /commit skill. |
| allowed-tools | Bash(git log:*), Bash(read-commit-instructions:*) |
| user-invocable | false |
| effort | medium |
コミットメッセージを書く際のスタイルガイドラインです。
/commitスキル経由でないコミットでも、
このガイドラインに従ってください。
既存コミットスタイル
!git log --no-merges -20
上記のgit log --no-merges -20の内容から、
既存のコミットメッセージのスタイルを把握してください。
コミットメッセージのガイドライン
!read-commit-instructions
上記の内容が空でなければプロジェクト固有のコミットメッセージガイドラインです。
内容に従ってください。
コミットメッセージのスタイル
プロジェクト固有のガイドラインと衝突するスタイルがある場合はそちらを優先してください。
以下はデフォルトのスタイルとして使用してください。
丁寧語とですます調で書いてください。
英単語と日本語が混在する場合は、
英単語の前後にスペースを入れないでください。
中国語の風習では普通スペースを入れますが、
日本語ではスペースを入れないのも一般的で、
私は基本的にスペースなしのスタイルを採用しています。
1行目はタイトルなので簡潔に変更の要約をしてください。
タイトルは68文字以内に収めることが推奨されます。
必要に応じて空行の後に本文を追加してください。
本文の行長は100文字以内に収めてください。
URLなど改行できないものを挿入する場合は例外です。
改行位置は句読点の後など、
自然な場所を選んでください。
不自然な場所で改行はしないでください。
改行位置が不自然になるぐらいなら文章を練りなおしてください。
日本語は英語と違い好きに改行して良い言語ではないので、
改行位置には十分注意してください。
コードのシンボル(関数名や変数名など)をメッセージに含める場合は、
Markdownのインラインコード記法であるバッククォートで囲んでください。
GitHub向けのissueに関連付けるキーワードはcloseなどの原形を使ってください。
本文には変更の内容だけではなく、
なぜその変更が必要だったのか、
理由をなるべく書いてください。
