GitHub English Challenge Cheat Sheet

  • 990
    Like
  • 6
    Comment

GitHub上の実際のコミットメッセージやIssueのやりとりをみて、チートシート作りました。

共通的なこと

  • コミットメッセージやIssueのタイトルは、主語省略し、1文で書き行末ピリオドは付けない
  • 動詞は現在形・過去形のどちらも同じくらいの頻度で見られるが、どちらかに揃える。

コミットメッセージを書く

Japanese English
Aを実装しました Implement A
機能(クラス)BにAを実装しました Add A to B
機能(クラス)BのAをリファクタリングしました Refactor A in B
AをBからCに変更しました Change A from B to C
AでなくBを使うようにしました Replace A with B
機能(クラス)Aのテストを追加しました Add test for A
機能(クラス)Aの失敗していたテストを修正しました Fix broken A tests
依存ライブラリAをバージョンx.y.zに上げました Update A to x.y.z
ファイルA中の誤字を修正しました Fix typo in A
〜のとき〜するバグを修正しました Fix the problem where 〜 when 〜
機能(クラス)Aについて、Bにも対応しました Support B in A
ドキュメントAのBに関する記述を修正しました Improve B in A
Aで発生するエラーメッセージを見直しました Improve error message thrown in A
バージョンx.y.zをリリースしました Release x.y.z

本当は避けたほうが良いが、細かい修正をまとめてコミットするときのコメント用例

Japanese English
依存ライブラリのバージョンを諸々更新しました Update dependencies
雑多なコードフォーマット修正・可視性の修正をしました Polish
コンパイル・静的解析の警告を出ないように修正しました Clean up

問い合わせる

Japanese English
〜する予定はありますか? Do you have any plans to 〜 ?
(このプロダクトを使って)〜することはできますか? Is there any way
回避策ありませんか? Is there a workaround?
~してないのって、何か理由ありますか? What is the reason for not ~?
設定/実装例がほしいです Could you provide an example please?
どうぞよろしくお願いします Thanks in advance.
〜するとNullPointerExceptionがでます We get NPE when 〜
このドキュメントを日本語に翻訳してもいいですか? Can I translate the docs to Japanese?
クローズしちゃっていいですか? Can I close this?
バージョンx.y.zでも、まだこのバグ潰れてないです I still encounter this bug with x.y.z.

問合せに答える

Japanese English
再現できないですねぇ… I'm afraid I can't reproduce the error you're seeing.
もうちょっと情報ください You'll need to provide a little more information than that.
スタックトレースはありませんか? Could you provide a stack trace?
そこがまさに問題なんです That's exactly the problem.

お礼をいう

Japanese English
とても勉強になりました I think I've learned a lot.
オッ、分かりました! I see now.
フィードバックありがとう Thanks for the feedback.
何か他にもありましたら、よろしくお願いします You're more than welcome to contribute.
もし解決できたら、プルリク送ってください If you are able to resolve this, we would encourage you to send a pull request.
ちゃんと動きました! It's working as expected.