ネイティブスピーカーが選ぶ!使える英語コミットコメント10選

f:id:vasilyjp:20180927140236j:plain

 

VASILY新入りエンジニアのEricと申します。 フィラデルフィアから来ました。好きな漫画はHUNTER x HUNTERです。 今回は使える英語コミットコメントを10個紹介します。 Fix, Change, Reviseなど、日本人の方には違いが分かり辛いものも、実際の使い所が分かるようにしてみました。 是非知って、使ってみてください!

1. Fix

意味: 直す, 修理する 使い方: バグなどが出たためコードを書き直す必要があう場合に使います。何か問題を直して、正確な操作に戻すニュアンスが強いです。 例:  Fix inequality in LinesComponent 訳: LinesComponentにおける不等式を書き直す

2. Revise

意味: 変更する、修正する 使い方: バグは出ていませんが、不十分なところや修理が必要としたところがあって、コードをよりよくする時に使うことが多い。考え直して、改善するというニュアンスを持っています。 例:  Revise User class variable types 訳: Userクラスにおいている変数の種類を修正する

3. Change

意味: 変更、変える 使い方: 前もっていた状態を変えるというニュアンスが強い。ある値を持っていた変数に別の値をつけたり、クラスなどの造りを変更したりする時に良く使います。 例:  Change var names for consistency 訳: 一貫性のために変数名を更新する

4. Update

意味: 更新する、新しくする 使い方: 最新の情報などに対応するためにコードやドキュメントを変更する時によく使います。最近変化した別のものにマッチするというニュアンスが入っています。 例:  Update documentation to show new methods 訳: ドキュメントを新しいメソッドを反映するようにアップデートする

5. Upgrade

意味: 更新する、改善する 使い方: プロジェクトなどの部分やライブラリーのバージョンを更新する時によく使います。Updateとの違いは微妙ですが、バージョン番号などが変わる時に使うことが多いです。 例:  Upgrade to markdown-preview@0.74 訳: `markdown-preview`をバージョン0.74に更新する

6. Clean up

意味: 片付ける、奇麗にする 使い方: 分かりにくかったり、無駄があったりしたところを片付けて、分かりやすくする時に使うことが多いです。 例:  Clean up specs based on feedback. 訳: フィードバックに従ってスペックを片付ける

7. Remove

意味: 削除する、取り除く、除去する 使い方: 以前コードに入っていたものを取り除く時に使います。 例: remove decoratorType instance var  `decoratorType`というインスタンス変数を削除する

8. Revert

意味: 取り消す、元に戻す 使い方: プロジェクトなどを元の状態に戻す時に使います。 例:  Revert to version 1.0.9 訳: バージョン1.09に戻す

9. Add

意味: 追加する、加える 使い方: 今までなかったものを追加する時によく使います。 例:  Add `has-selection` class to the editor div 訳: `editor` div に`has-selection`というクラスを追加する

10. Implement

意味: 実装する 使い方: ある追加したい機能やフィーチャーがあって、実際にコードを書いてプロジェクトに入れる時に使います。 例:  Implement removeDecorations class 訳: `removeDecorations`というクラスを実装する   英語でコミットコメントが書けると、githubなどで世界中のプロジェクトに参加して多くのエンジニアと一緒に仕事ができるので刺激的です。 挑戦してみてください!  

VASILY iOSエンジニアによるApple WWDC報告会を開催します!

・日時:6月27日(金)20:00〜22:00 (20:00〜21:00 Apple WWDC報告会、21:00〜22:00 オフィスで懇親会) ・場所:東京都渋谷区恵比寿3-42-13 1F     株式会社VASILY(http://bit.ly/1mQQMDs) ・参加費:無料 ・定員:15名 ※ご参加は学生、社会人問わずApple Developer Programsに加入していらっしゃる方のみとさせて頂きます。 ※定員制のため、応募者多数の場合は抽選とさせていただきます。ご招待する方のみ 6/20(金)にメールにてご連絡いたします。 VASILY iOSエンジニアによるApple WWDC報告会のお申し込みはこちらから

カテゴリー