Yuta NakataのBlog

Python / AWS / ITについて役立つ情報を発信します

PR前にやって欲しいこと3選

現代のソフトウェア開発ではかかせないGit/GitHub

GitHubを使ったチーム開発は、現代ではマストだと思います。

そこで、現場のエンジニア目線でこれだけはやっておいてほしい3選を紹介します。

他にも、色々言いたいことはありますが、、、、まずは、これだけ抑えてほしい!というポイントです。

結論

以下、詳細を説明します。

単体テストを実施する

開発したコードは、必ずバグを含んでいます

必ず単体テストを行いましょう。

例えば、、、

  • APIを作ったなら、想定した挙動で動いていますか? また、例外的な入力値でも適切に動きますか?

  • フロントエンドを作ったなら、各挙動が想定どおりですか?表示が乱れていないですか?例外処理は正しいですか?

これらの試験を行った上で、結果をPRに合わせて記載しましょう。

特に、自動テスト(pytest、selenium等)を使って行うことを推奨します。

なぜなら、今後の要件変更で影響を受けた際に、影響範囲が明確になるからです。

不要なファイルやコードを削除すること

もう一度コード全て読み直してみてください。

大丈夫

と大体のエンジニアが高を括っています。

  • print()が紛れ込んでないですか?

  • そのファイルは本当に管理対象ですか?ローカルで実行したときに、残っているものでないでしょうか?

不要なコードは削除しましょう。

不要なファイルは削除するだけでなく、.gitignoreにも追加しましょう。

.DS_Storeは基本的にいりません。

READMEを記載すること

メンバーは、背景や意図を理解していません

開発したあなたにとっての、”当たり前”はチームメンバーの当たり前ではありません。

狙いや意図、背景等、ちゃんと説明しましょう。

特に、AWS構成図等や設計図などは必ず記載しましょう。

関連書籍

下記の本は基本を勉強する上では、おすすめです。

ただし、扱っている内容が古い部分もあるので、そこは適宜読み替えが必要です。

GitHub実践入門 ~Pull Requestによる開発の変革 (WEB+DB PRESS plus) | 大塚 弘記 |本 | 通販 | Amazon