GGI Activity: 推廣開放原始碼開發最佳實踐

Table of contents

推廣開放原始碼開發最佳實踐

行動編號：GGI-A-25。

描述

此行動旨在於開發團隊內部定義、積極推廣並落實開放原始碼最佳實踐。

作為起點，可以考慮以下幾個重點主題：

  • 使用者與開發者文件。
  • 將專案妥善組織於公開可訪問的儲存庫中。
  • 推廣並落實受控重複使用。
  • 提供完整且最新的產品文件。
  • 配置管理：Git 工作流程、協作模式。
  • 發布管理：頻繁發布及早交付，穩定版與開發版之間的管理等。

開放原始碼專案具有特殊的類市集型運作模式。為了促進此合作模式及思維，建議採用一些實務，以支持協作式及分散式開發，並促進來自第三方開發者的貢獻……

社群文件

確保公司內所有專案均提供以下文件：

  • README —— 專案的簡要說明、如何參與、資源連結。
  • Contributing —— 為願意貢獻的人提供的指南。
  • Code Of Conduct —— 社群內可接受或不可接受的行為準則。
  • LICENSE —— 儲存庫的預設授權條款。

REUSE 最佳實踐

REUSE 是歐洲自由軟體基金會提出的倡議，旨在改善軟體重複使用並簡化開放原始碼及授權合規流程。

機會評估

儘管這在很大程度上取決於團隊的開放原始碼共識知識，但對人員進行培訓及建立落實這些實務的流程仍然大有裨益。這在以下情況下更為重要：

  • 潛在的使用者與貢獻者尚未確定，
  • 開發者尚未習慣於開放原始碼開發。

進度評估

以下檢驗要點顯示了此行動的進度：

  • 專案制定了一套符合的開放原始碼最佳實踐清單。
  • 專案監控其與最佳實踐的一致性。
  • 開發團隊已建立對遵循開放原始碼最佳實踐的認識。
  • 新的最佳實踐會定期評估，並努力加以落實。

工具

  • REUSE 輔助工具 協助讓儲存庫符合 REUSE 最佳實務。該工具可以整合至多數開發流程中，以確認當前狀態。
  • ScanCode 能夠列出儲存庫內的所有社群與法律文件：請參閱功能描述。
  • GitHub 提供一項功能，可檢查遺漏的社群文件。可以在儲存庫頁面 >「Insights」>「Community」中找到此功能。

建議

  • 最佳實務清單依專案的背景及領域而有所不同，應定期重新評估，以持續改善方式進行監控與追蹤進度。
  • 培訓人員關於開放原始碼的重複使用（作為使用者）及生態系統（作為貢獻者）。
  • 落實 REUSE.software（詳見行動#14）。
  • 建立流程以管理與重複使用及貢獻相關的法律風險。
  • 明確鼓勵人員貢獻於外部專案。
  • 提供專案結構的範本或官方指南，幫助統一規範。
  • 配置自動化檢查，以確保所有專案符合指引。

資源

建議的下一步行動