はじめに
OSSにコントリビューションする際に敷居が高い点で英語によるコミットメッセージがあると思います。
そこで、英語が苦手な方でも気軽にコントリビューションできるように、英語のコミットメッセージ集を作成しました。
このコミットメッセージ集を参考にすれば、大体のコミットメッセージはカバーできると思います。
Let's contribute to OSS!
辞典
○○を追加した
Add ○○
ファイルや機能などを追加した際に使用します。
例文
- ビルドスクリプトを追加した
Add build script - ボタンコンポーネントを追加した
Add button component - ヘッダーコンポーネントにロゴを追加した
Add logo to header component - 投稿作成時のテストコードを追加した
Add test for post creation
○○を削除した
Remove ○○
ファイルやコードを削除した際に使用します。
例文
- 使用していないアイコンファイルを削除した
Remove unused icon files - 使用していない関数を削除した
Remove unused functions - 不要な改行を削除した
Remove unnecessary line breaks - 不要な関数呼び出しを削除した
Remove unnecessary function calls
○○を修正した
Fix ○○
バグ修正やタイポ修正などを行った際に使用します。
例文
- ファイル名のタイポを修正した
Fix typo in file name - Windowsでビルドが通らないバグを修正した
Fix build error on Windows - ボタンをホバー時に色が変わらないバグを修正した
Fix button not changing color when hovering - 投稿作成時に通知が送信されないバグを修正した
Fix post creation notification not being sent
○○を更新した
Update ○○
ライブラリの更新やドキュメントの更新などを行った際に使用します。
例文
- README.mdを更新した
Update README.md - TypesScriptをv5.0.0に更新した
Update dependency typescript to v5.0.0 - プロジェクトのセットアップ手順を更新した
Update project setup instructions - ドキュメントのリンク切れを更新した
Update broken links in documentation
○○を移動した
Move ○○
ファイルやコードの定義を移動した際に使用します。
例文
- コンポーネントの定義ファイルをcomponentsディレクトリに移動した
Move component definition files to components directory - ユーティリティ関数をutilsディレクトリに移動した
Move utility functions to utils directory - テストコードをtestsディレクトリから__tests__ディレクトリに移動した
Move test code from tests directory to __tests__ directory - validateメソッドをPostクラスからPostValidatorクラスに移動した
Move validate method from Post class to PostValidator class
名前を○○に変更した
Rename ○○
ファイルや変数などの名前を変更した際に使用します。
例文
- コンポーネントのファイル名をキャメルケースからケバブケースに変更した
Rename component file names from camel case to kebab case - Postのクラス名をPostModelに変更した
Rename the Post class name to PostModel - テストコードのファイル名を**.test.tsから**.spec.tsに変更した
Rename test code file name from **.test.ts to **.spec.ts - ユーティリティ関数のディレクトリををutilsからhelpersに変更した
Rename utility functions directory from utils to helpers
○○の代わりに□□を使用するようにした
Use □□ instead of ○○
使用するライブラリやコードを変更した際に使用します。
例文
- テストランナーをJestの代わりにViteを使用するようにした
Use Vite instead of Jest as test runner - TypeScriptのビルドツールをtscの代わりにesbuildを使用するようにした
Use esbuild instead of tsc as TypeScript build tool - E2EテストのフレームワークをCypressの代わりにPlaywrightを使用するようにした
Use Playwright instead of Cypress as E2E test framework - 配列をループする際にfor文の代わりにforEachを使用するようにした
Use forEach instead of for loop when looping through arrays
○○を出来るようにした
Make it possible to ○○
新たに何かが出来るようになった際に使用します。
例文
- ボタンコンポーネントにアイコンを追加できるようにした
Make it possible to add icons to button components - ボタンコンポーネントのカラーテーマを変更できるようにした
Make it possible to change color theme of button components - 投稿が削除できるようにした
Make it possible to delete posts - ユーザーが投稿を検索できるようにした
Make it possible for users to search posts
Discussion