[script]Git Commit時のメッセージを統一するスクリプト書いてみた

目次

経緯

これまでコミットのコメントがメンバーによってバラつきがあり、
読みにくいことが多かったため作ってみた。

スクリプトファイルダウンロード

下記ファイルをダウンロード

ファイル配置

ファイルを下記に配置する
※任意の箇所で問題ない。私の場合は `~/.shell`に配置しています。

エイリアスの設定

設定

vim .zshrc
alias commit='sh ~/.shell/git-commit-msg.sh'

適用

source ~/.zshrc

実行方法

$ commit
 1) feat: 新機能
 2) fix: バグ修正
 3) docs: ドキュメントのみの変更
 4) style: フォーマットの変更(コードの動作に影響しないスペース、フォーマット、セミコロンなど)
 5) refactor: リファクタリングのための変更(機能追加やバグ修正を含まない)
 6) perf: パフォーマンスの改善のための変更
 7) test: 不足テストの追加や既存テストの修正
 8) build: ビルドシステムや外部依存に関する変更(スコープ例: gulp, broccoli, npm)
 9) ci: CI用の設定やスクリプトに関する変更(スコープ例: Travis, Circle, BrowserStack, SauceLabs)
10) chore: その他の変更(ソースやテストの変更を含まない)
11) revert: 以前のコミットに復帰
#?  1
関連issueを追記:(enterでスキップ)
> TEST-678
変更内容のスコープ(例:コンポーネントやファイル名):(enterでスキップ) 
> 新しいフォームを追加
変更内容を要約した本質的説明 
> フォームを追加、桁数のバリデーションのみ実装
feat(新しいフォームを追加): フォームを追加、桁数のバリデーションのみ実装 (TEST-678)
変更内容の詳細:(enterでスキップ) 
> テスト済み
> バリデーション実装
> 
feat(新しいフォームを追加): フォームを追加、桁数のバリデーションのみ実装 (TEST-678)

テスト済み
バリデーション実装
破壊的変更を含みますか? y/n [ n ] 
> n
feat(新しいフォームを追加): フォームを追加、桁数のバリデーションのみ実装 (TEST-678)

テスト済み
バリデーション実装
このコミットメッセージでよろしいでしょうか?y/n 
yの場合、そのままコミットを行います
nの場合、コミットを行わず終了します
> y

この記事を書いた人

目次