Table of contents
コードレビューの実行
アクティビティ ID: GGI-A-44 (EN)
説明
コードレビューは、製品をリリースしたり、プロジェクトを顧客に提供したりする前に、アプリケーションのソースコードを手動または自動でレビューする日常的なタスクです。オープンソースソフトウェアの場合、コードレビューは単にエラーを機会に応じて検出するだけではありません。チームレベルで実行される共同開発への統合アプローチです。
コードレビューは、社内で開発されたコードだけでなく、外部ソースから再利用されたコードにも適用する必要があります。コードに対する一般的な信頼を高め、所有権を強化するためです。また、チーム内のグローバルなスキルと知識を強化し、チームのコラボレーションを促進する優れた方法でもあります。
機会評価
コードレビューは、組織がソフトウェアを開発したり、外部のソフトウェアを再利用したりするたびに役立ちます。ソフトウェアエンジニアリングプロセスの標準的な手順である一方で、オープンソースのコンテキストでのコードレビューには、次のような特定の利点があります。
- 内部ソースコードを公開する場合は、適切な品質ガイドラインが遵守されていることを確認します。
- 既存のオープンソースプロジェクトに貢献する場合は、対象プロジェクトのガイドラインが尊重されていることを確認してください。
- 公開されているドキュメントがそれに応じて更新されます。
また、次のような会社の法的コンプライアンスポリシールールの一部を共有して適用する絶好の機会でもあります。
- 再利用されたオープンソースコードにある既存のライセンスヘッダーや著作権を決して削除しないでください。
- 法務チームの事前の許可なしに、Stack Overflow からソースコードをコピーして貼り付けないでください。
- 必要な場合は、正しい著作権表記を含めてください。
コード レビューは、コードに対する信頼と自信をもたらします。ソフトウェア製品の品質や使用の潜在的なリスクについて確信が持てない場合は、ピア レビューとコード レビューを実施する必要があります。
進捗評価
次の検証ポイントは、このアクティビティの進捗状況を示しています:
- オープンソースコードレビューは必要なステップとして認識されています。
- オープンソースコード レビューが計画されています (定期的にまたは重要な瞬間に)。
- オープンソースコードレビューを実施するためのプロセスが共同で定義され、承認されています。
- オープンソースコードレビューは開発プロセスの標準的な部分です。
推奨事項
- コード レビューは共同作業であり、良好な共同作業環境でより効果的に機能します。
- コードレビューが長年 (数十年) 標準となっているオープンソースの世界の既存のツールとパターンをためらわずに使用してください。
リソース
- コードレビューとは (EN): Red Hat の Open Practice Library にあるコードレビューに関する教訓的な読み物。
- コードレビューのベストプラクティス (EN): コードレビューとは何かについての別の興味深い視点。
次のアクティビティの提案
- GGI-A-26 - オープンソースプロジェクトへの貢献 (EN) コードレビューは、コードの品質と知識の共有を向上させるため、オープンソースプロジェクトでは一般的な方法です。コードレビューを行う貢献者は通常、外部からの貢献やコラボレーションに安心感を覚えます。