Git Commit ワークフロー
基本原則
- pre-commit設定時は検査が通る状態でコミット (バイパス禁止)
- 意味のある最小単位でコミット
git status --short --untracked-filesで確認し--untracked-files=noを使わない
- メッセージが複数の意味を示す時は分割
- レビュー対応を「レビュー修正」等で1コミットに纏めない。各修正を個別の意味単位でコミットする
- コマンド実行に
git -Cは使用しないこと - Push操作はユーザーが実行するので実施しない
- spec-kit関連ファイル (
.specifyやspecs/)はGlobal gitignoreで除外済みなので、コミットしない- ただし、リポジトリの.gitignoreで上書きしている場合は従うこと
git addとgit commitをPermissionで許可しているので、それぞれ別コマンドとして実行すること (&&などで繋げない)
コミットメッセージ規則
- 本文は大文字で始め、変更の理由を明確にする
- 個人リポジトリ (
$HOME/ghq/github.com/peacock0803sz/配下) ではEmoji Prefixを採用- ただしdotfilesリポジトリ(
$HOME/dotfiles)はEmoji Prefixを採用していない
- ただしdotfilesリポジトリ(
Emoji Prefix一覧
| Emoji | 用途 |
|---|---|
| :tada: | 最初のコミット/新機能(大) |
| :sparkles: | 新機能(小) |
| :bug: | バグフィックス |
| :recycle: | リファクタリング |
| :books: / :bulb: | ドキュメント |
| :art: | フォーマット改善 |
| :zap: | アップデート |
| :fire: | コード/ファイル削除 |
| :white_check_mark: | テストコード追加 |
| :green_heart: | CI/CD関連修正 |
| :arrow_up: / :arrow_down: | 依存関係変更 |
| :wrench: | 設定ファイル関連 |
| :snowflake: | Nix関連 |
| :ambulance: | ホットフィックス |
| :construction: | WIP |
詳細は $HOME/dotfiles/.config/git/commit-template を参照。
Converted and distributed by TomeVault — claim your Tome and manage your conversions.