Table of contents
オープンソース開発のベストプラクティスの推進
アクティビティ ID: GGI-A-25 (EN)
説明
このアクティビティは、開発チーム内でオープンソースのベストプラクティスを定義し、積極的に推進し、実装することです。
出発点として、次のトピックに注目することが考えられます。
- ユーザーおよび開発者のドキュメント。
- 公開アクセス可能なリポジトリでプロジェクトを適切に整理すること。
- 制御された再利用の推進および実装。
- 完全で最新の製品ドキュメントの提供。
- 構成管理: Git ワークフロー、共同作業パターン。
- リリース管理: 早期リリースと頻繁なリリース、安定バージョンと開発バージョンなど。
OSS プロジェクトには、バザールのような (MULTI) 特別な手法があります。このコラボレーションと考え方を可能にし、促進するために、サードパーティの開発者による共同開発と分散開発および貢献を促進するいくつかのプラクティスが推奨されます…
コミュニティドキュメント
会社内のすべてのプロジェクトで次のドキュメントが提案されていることを確認します:
- README – プロジェクトの簡単な説明、やり取りの方法、リソースへのリンク。
- Contributing – 貢献したい人向けの紹介。
- Code Of Conduct – コミュニティ内での行動として許容されるもの (または許容されないもの)。
- LICENSE – リポジトリのデフォルトのライセンス。
REUSE のベストプラクティス
REUSE (MULTI) は、ソフトウェアの再利用を改善し、OSS とライセンスのコンプライアンスを合理化するための、Free Software Foundation Europe (MULTI) の取り組みです。
機会評価
チーム内の OSS の共通知識に大きく依存しますが、人材をトレーニングし、これらのプラクティスを強制するプロセスを作成することは常に有益です。次の場合はさらに重要です。
- 潜在的なユーザーや貢献者が不明である。
- 開発者はオープンソース開発に慣れていない。
進捗評価
次の検証ポイントは、このアクティビティの進捗状況を示しています:
- プロジェクトは、準拠するオープンソースのベストプラクティスのリストを設定します。
- プロジェクトは、ベストプラクティスとの整合性を監視します。
- 開発チームは、OSS のベストプラクティスに準拠することについての意識を高めています。
- 新しいベストプラクティスが定期的に評価され、それらを実装するための努力が行われます。
ツール
- REUSE ヘルパー ツール (MULTI)は、リポジトリを REUSE (MULTI) ベストプラクティスに適合させるのに役立ちます。現在のステータスを確認するために、多くの開発プロセスに組み込むことができます。
- ScanCode (EN) には、リポジトリ内のすべてのコミュニティ文書と法的文書をリストする機能があります。機能の説明 (EN)を参照してください。
- GitHub には、コミュニティドキュメントの欠落をチェックする優れた機能 (EN)があります。これは、リポジトリページ > 「Insights」 > 「Community」にあります。
推奨事項
- ベストプラクティスのリストはプログラムの状況と領域に依存するため、継続的な改善方法で定期的に再評価する必要があります。進捗状況を追跡するために、実践を監視し、定期的に評価する必要があります。
- OSS の再利用 (消費者として) とエコシステム (貢献者として) について人々をトレーニングします。
- アクティビティ #14 のように REUSE.software を実装します。
- 再利用と寄付に関連する法的リスクを管理するプロセスを設定します。
- 外部プロジェクトへの貢献を明示的に奨励します。
- プロジェクト構造のテンプレートまたは公式ガイドラインを提供します。
- すべてのプロジェクトがガイドラインに準拠していることを確認するために、自動チェックを設定します。
リソース
- Market Readiness Levels 評価手法からの OW2 のオープンソースのベストプラクティスのリスト (EN) 。
- REUSE の公式 Web サイト (MULTI)には仕様、チュートリアル、FAQ が掲載されています。
- GitHub のコミュニティガイドライン (EN)
- GitHub を使用した構成管理のベストプラクティス (EN)の例
次のアクティビティの提案
- GGI-A-42 - オープンソースのスキルとリソースの管理 (EN) 特定されたオープンソース開発のベストプラクティスのリストを一般的なトレーニング資料に追加できます。
- GGI-A-44 - コードレビューの実行 (EN) コードレビューは、開発のベストプラクティスの重要な要素です。