メインコンテンツへスキップ

新規ページ

📝 はじめに

この記事では、GitHubのコミットコメントにおける先頭タグを、Conventional Commits仕様に準拠してまとめました。これにより、変更の種類を一目で把握でき、CI/CDツールやリリースノート生成ツールとも連携しやすくなります。


🔧 変更の種類別タグ(Conventional Commits)

🐛 fix: バグ修正

バグや不具合の修正に使用します。
例)fix: ログインエラー修正

✨ feat: 新機能追加

新しい機能や仕様の追加に使用します。
例)feat: ユーザー検索機能追加

🔨 refactor: リファクタリング

動作を変えないコードの改善(構造や可読性の向上)に使用します。
例)refactor: ユーティリティクラス整理

🧹 chore: その他メンテナンス

ビルドプロセスや補助ツールの変更、ライブラリ更新などに使用します。
例)chore: 依存関係アップデート

🎨 style: スタイルの修正

フォーマットやインデント、セミコロンなどの修正(動作に影響なし)に使用します。
例)style: prettier適用

🧪 test: テストコード追加・修正

テストコードの追加、修正、テスト関連設定の変更に使用します。
例)test: ログイン処理のテストケース追加

📚 docs: ドキュメント変更

READMEやコードコメント、その他ドキュメントの修正や追加に使用します。
例)docs: API使用例追加

🛠️ build: ビルドシステム関連

ビルドシステムや外部依存、ビルドプロセスの変更に使用します。
例)build: Webpack設定変更

🏗️ ci: CI設定

CI(継続的インテグレーション)の設定ファイルやスクリプトの変更に使用します。
例)ci: GitHub Actions追加


⚠️ 注意

Conventional Commitsは、冒頭に「type:」をつける形式で書きます(例:feat:)。オプションでスコープ(変更対象)を括弧で追加できます(例:feat(auth):)。

BREAKING CHANGE:(破壊的変更)を含めることで、バージョン管理(例えばSemVer)やリリースノート生成ツールと連携しやすくなります。


📊 一覧表(Conventional Commits)

タグ 用途
feat 新機能追加 feat: ユーザー検索機能追加
fix バグ修正 fix: ログインエラー修正
docs ドキュメント修正・追加 docs: API使用例追加
style フォーマット、スペース、セミコロン等 style: prettier適用
refactor リファクタリング(動作変更なし) refactor: ユーティリティクラス整理
test テストコード追加・修正 test: ログイン処理のテストケース追加
build ビルドシステム、外部依存関係 build: Webpack設定変更
ci CI設定(GitHub Actionsなど) ci: GitHub Actions追加
chore その他のメンテナンス作業 chore: 依存関係アップデート

🎯 まとめ

Conventional Commitsを使えば、変更内容が一目で分かるだけでなく、自動化ツールやバージョン管理とも相性が抜群です。チームでのコミュニケーションも円滑になるので、ぜひプロジェクトに取り入れてみてくださいね!