コードレビュー - gosaaan1/hokulea-garage GitHub Wiki

チェックリスト

Python初心者から中級者に役立つ、コードレビュー前のチェックリストを作りたいと思っています。

前提条件：

  • プロジェクトではPython3.11 以降を使っています。
  • エディタに Visual Studio Code を使っています。
  • 可読性向上、コードの品質向上に必要な拡張機能やツールを積極的に導入します。
  • 良いコードと悪いコードの具体的な例をあげ、読者に端的でわかりやすい説明にしたいです。

Pythonのコードレビュー前にチェックすべき項目のリストを作成することは、コードの品質を保つ上で非常に重要です。以下に、Python初心者から中級者がチェックすべきポイントをまとめたチェックリストを提供します。

コードレビューチェックリスト

1. コーディングスタイル

  • PEP 8に準拠していますか？
  • 変数名や関数名は意味のある名前になっていますか？
  • インデントはスペース4つで統一されていますか？

2. コードの構造

  • 関数やクラスは単一責任を持っていますか？
  • コードはDRY（Don't Repeat Yourself）原則に従っていますか？
  • グローバル変数の使用を避けていますか？

3. コメントとドキュメンテーション

  • 各関数とクラスにドキュメンテーションコメントはありますか？
  • コメントはコードを補足するものになっていますか？

4. エラーハンドリング

  • エラーは適切にキャッチされていますか？
  • ユーザーにとって理解しやすいエラーメッセージを提供していますか？

5. テスト

  • 単体テストは十分に書かれていますか？
  • テストはコードの変更に対して堅牢ですか？

6. セキュリティ

  • 機密情報はコードにハードコードされていませんか？
  • 外部からの入力は適切にサニタイズされていますか？

7. パフォーマンス

  • コードは効率的に書かれていますか？
  • 不必要な計算やデータ構造は避けられていますか？

8. バージョン管理

  • コミットメッセージは明確で情報的ですか？
  • コードは適切にブランチされていますか？

9. 依存関係

  • 使用しているライブラリは最新かつ安全ですか？
  • 必要ないライブラリやモジュールは削除されていますか？

10. プロジェクトの構成

  • プロジェクトのディレクトリ構造は整理されていますか？
  • 設定ファイルや環境変数は適切に管理されていますか？

Visual Studio Codeの拡張機能

Visual Studio CodeでのPython開発を効率化するために、以下の拡張機能の導入をお勧めします。

  • PylintまたはFlake8: コードのリンティングに使用します。
  • autopep8またはBlack: コードの自動フォーマットに使用します。
  • isort: インポート文の整理に使用します。
  • Mypy: 型チェックに使用します。
  • Jupyter: Jupyterノートブックのサポートに使用します。
  • Python Docstring Generator: ドキュメンテーションコメントの生成に使用します。

これらのツールと拡張機能を活用することで、コードの品質を向上させ、より読みやすくメンテナンスしやすいコードを書くことができます。また、良いコードと悪いコードの具体例を示すことで、理解を深めることができます。¹1²2³3⁴4

コードレビューは、単にコードをチェックするだけでなく、チームメンバー間で知識を共有し、コードベースを改善するための重要なプロセスです。このチェックリストが役立つことを願っています。

ソース: Bing との会話 2024/4/27 (1) Python3 Linter: コード品質を向上させる究極のガイド – EcoAGI. https://ecoagi.ai/ja/topics/Python/python3-linter. (2) Pythonプロジェクトにlinter・formatterを導入してコードの品質を .... https://qiita.com/ikeike_ryuryu/items/ce92f1a650958b419bbb. (3) PyCharmでコードの品質を保つために #Python - Qiita. https://qiita.com/AJIKING/items/a486be4374bb67e0924f. (4) Python単体テスト入門 – あなたのコードの品質を向上させる方法 .... https://nullpo-dev.net/programming/python/pytest/. (5) コードレビュー チェックリスト #コードレビュー - Qiita. https://qiita.com/yuyakato/items/f3f22f5ec366a650aa51. (6) ソースコードレビューのやり方や観点のチェックリストを解説 .... https://applis.io/posts/how-to-do-source-code-review. (7) Pythonセルフレビューチェックリスト #Python - Qiita. https://qiita.com/nicco_mirai/items/41e1e13680f645630a63. (8) コードレビューを初めて行う人必見！やり方を1から解説 .... https://and-engineer.com/articles/YDCJfhAAACEAIa3y. (9) バグを増やさないためにコードレビューのチェックリストを .... https://yakst.com/ja/posts/1569. (10) 【2024年最新】Python開発で便利なVSCode拡張機能 .... https://pythonsoba.tech/vscode-extension/. (11) Python+VSCodeにおすすめの拡張機能 #Python - Qiita. https://qiita.com/momotar47279337/items/73157407ae824751afc4. (12) Visual Studio Code オススメ拡張機能&設定 Pythonエンジニア向け. https://tako-xyz.com/visual-studio-code-python-extensions/. (13) 「Python」のVS Code拡張機能が強化、チュートリアルで .... https://forest.watch.impress.co.jp/docs/news/1431011.html. (14) undefined. https://pre-commit.com. (15) undefined. https://pre-commit.com/hooks.html. (16) undefined. https://github.com/pre-commit/mirrors-mypy.