《GitHub》プルリクエストを出す時に注意すべき点をまとめた

Git

PullRequestを出す時に気をつけるべき点

1つの修正に1つのcommit

レビュワーから「〜の部分と〜〜の部分を修正してください」という依頼を受けて、ローカルで修正したものをリモートのリポジトリにpushするとき、原則として2つの修正依頼を1つのcommitにまとめてはいけません。レビュワーは1つずつ指摘した修正依頼箇所が直っているかを確認するので、1つのcommitに修正依頼が複数混ざっているとレビュワーの確認負荷が上がり、労力をかけることになります。

命名が長いのはNG

プロパティ、関数の命名でやたらわかりやすさを重視して、やたら長い名前をつけてました。しかしこれもNG。というのもその命名は大体が誤っていることが多かったのです。誤っているか、本来担う機能以上のことを書いているパターンが多かったです。関数に関しては、「その関数は何をするのか」という点に着眼するといいです。詳しくは有名な著書「リーダブルコード」を読むと命名に関するコツが全てわかります。

commitメッセージは具体的に書く

commitメッセージは具体的に書きましょう。fix bug といったcommitメッセージはアンチパターンです。後々見返した時になんのbugを修正したのかわからなくなってしまうからです。もっと高レベルのコメントを書きましょう。高レベルのコメントというのはプログラムだけではわからない変更背景を文字にして書くことです。

なぜ変更を加えたのかのメモを書くべき

Files Changed画面で変更箇所に対して、コメントを書くことができます。

なぜ変更する必要があるのか?というのをレビュワーがコードだけを見て判断しづらいと思う箇所はなぜ変更を加えたのかを書くべきです。こうするとレビューする側の負担が減ります。またコメントを書くうちに情報が整理されて、自分自身でもっと良い書き方が見つかるということも多いです。

番外:おすすめアイテム

記事の内容とは別に自宅・オフィスでの開発がもっと快適に、楽しくなる商品を紹介します。アイテム1つで開発効率が一気に向上したり、開発のモチベーションが上がったりするので良いアイテムにはお金を投資すると良いかと。

KATUO
KATUO
今回紹介する商品は普段自分が使っているものなので自信を持ってお勧めできますー。では1つずつ紹介していきます。

おすすめアイテム①

自分はオフィス次の2点の座布団と背もたれクッションを利用してます。姿勢が安定し、お尻への負担が激減します。オフィスにいるのに自宅で作業しているような感覚になるので気に入ってます。また疲労感もかなり減るので費用対効果が非常に高いアイテムです。

おすすめアイテム②

ブックスタンドみなさん使ってますか?PCを打ちながら参考書見る時に手で抑える必要がなくなるので非常に便利です。自分も購入した時なんでいままで使ってなかたんだろうと後悔したのでまだ持ってない方は買っておくと作業効率があがります。

おすすめアイテム③

PCスタンド、magic keyboard、magic mouseを購入してから、開発効率があがり、身体的負担が減って快適に開発ができるようになりました。

エンジニアの基礎知識・教養

別の記事でエンジニアとして知っておくべき技術本についてまとめました。初心者には最低限読んでおいて欲しい技術本をまとめました。例えば「リーダブルコード」などは技術力の高いエンジニアなら必ず過去に読んでいる本だと思います。

筆者
筆者

今回の記事の内容は以上で終了です!最後まで読んでくれてありがとうございました!Twitterもやってるのでよかったらフォローしてください!

タイトルとURLをコピーしました