見出し画像

コードレビューしてもらい易いプルリク

おはようございます、Flutterエンジニアの山村です。

Flutterエンジニアとして稼いでいく上で、山村が大切にしている事などを、公式LINEで定期配信しています。

多くの方のお役に立ちたいので、過去の投稿をnoteにも投稿していこうと思います。


この投稿は2021年11月22日(月)の公式LINEの投稿を転記しております

おはようございます☀

いつも「Flutter好きが集まる朝もく会」にご参加いただき、ありがとうございます😊

今日は『コードレビューしてもらい易いプルリク』について、お話ししていきたいと思います🙋🏻‍♂️

開発案件に参加すると、先輩エンジニアさんにコードレビューをして頂く機会があると思います。

その時に、どんなプルリクエスト(略して、プルリク)を上げると、先輩エンジニアさんの負担を最小限に抑えて、コードに対する評価(コードレビュー)をもらえるでしょうか?

✅プルリクが最小単位になっている(複数の課題解決が混ざっていない)
✅プルリクの概要欄の説明が要点を押さえている(長過ぎず、短過ぎない)
✅動作確認の動画が添付されている(コードレビューでは、コードの動作確認までは行わない事が多いため)
✅コードに対するアドバイスが欲しい箇所にはTODOコメントが残されている
✅誰が見ても理解できるようなコードになっている(特に、変数名やメソッド名やコメント)

僕がコードレビューする時に、これらが、あると、とても助かります😊

良かったら、参考にしてみて下さいね〜

以上、月曜日の配信でした〜🙌🏻

Flutterを極めたい方 や 収入アップを目指したい方へ

・公式LINE(無料) → こちら
・朝もく会(無料) → こちら


この記事が気に入ったらサポートをしてみませんか?