More than 1 year has passed since last update.

[かんたんコミットメッセージ] Conventional Commits で使用可能な prefix の解釈

Last updated at 2023-10-13Posted at 2023-10-13

Conventional Commits

Angular.js の採用する規約では、☆のついた8つのプレフィックスを使用します。この場合、例えばbuildをchoreに含めます。

chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

chore: ビルド、補助ツール、ライブラリ関連

build: ビルドシステムや外部依存関係の変更に使用します。例えば、ビルドスクリプトやパッケージマネージャの設定の変更などが含まれます。
- e.g. ビルド設定ファイルの変更
- e.g. 依存関係の更新 (npm / Yarn)
```
build: 更新依存関係を追加
```
chore: おおむね雑用やタスクの変更に使用されます。特に意味がない単なる作業や、タスクランナーの設定の変更などが含まれます。
- e.g. package.json ファイル内の scripts セクションへの変更
- e.g. 新しくパッケージを追加 ($ yarn add react)
```
chore: ドキュメントの整理
```
ci: CI（継続的インテグレーション）の設定やスクリプトの変更に使用されます。
```
ci: テストスクリプトの修正
```
docs: ドキュメンテーションの変更に使用されます。
- e.g. READMEの追加や変更
- e.g. LICENSEの追加や変更
```
docs: READMEの更新
```
feat: 新しい機能の追加に使用されます。
```
feat: ユーザーログイン機能の追加
```

fix: バグ修正に使用されます。

fix: ユーザーログイン時のエラー修正

perf: パフォーマンスの向上に対する変更に使用されます。
```
perf: データベースクエリの最適化
```
refactor: コードのリファクタリングに使用されます。機能の変更はなく、単にコードの構造や可読性を向上させる目的です。
- e.g. ファイル名の変更
- e.g. プロジェクトのディレクトリ構造を変更
```
refactor: メソッドの名前変更
```
revert: 以前のコミットを取り消す目的で使用されます。
```
revert: 直前の変更を元に戻す
```
style: コードのスタイルやフォーマットの変更に使用されます。
- e.g. CSSデザインの変更
```
style: インデントの修正
```
test: テストコードの追加や修正に使用されます。
```
test: ユーザーログインのテストケース追加
```

プロジェクトやチームのコミットメッセージの規約によっては、choreプレフィックスが広範な雑用やタスクに関連する変更に使用されることもあります（e.g. プロジェクトのディレクトリ構造を変更）。プロジェクト内での一貫性が重要です。

なにか間違い等ありましたら、コメントをいただけると幸いです！