Standard for Public Code

← 貢獻要容易 ← Make contributing easy ← Make contributing easy 要求審查貢獻內容 → 要求審查貢獻內容 → Require review of contributions →

目次

  1. 需求規定
  2. 測試方式
  3. 公共政策制定者:需要的工作
  4. 管理人員:需要的工作
  5. 開發人員與設計師:需要的工作
  6. 延伸閱讀

維護版本控制

版本控制主要在追蹤原始碼以及其他程式基底檔案歷來的變動。這能讓您為程式基底維護有條理的變動歷史文件。這是大規模協作得以運作的要素,使開發人員可以 針對修改變動平行作業,並幫助未來的開發人員瞭解做出修改的原因。

需求規定

  • 程式基底中的所有檔案皆「必須」有版本控制。
  • 所有決定皆「必須」記錄成送交版次訊息。
  • 每份送交版次訊息皆「必須」盡可能附上討論與議題連結。
  • 程式基底「應該」以分散式版本控制系統作維護。
  • 貢獻守則「應該」要求貢獻者,將相關的修改變動以群組分類方式送交。
  • 維護人員「應該」使用像是修訂版次標記,或文字標籤,來標示程式基底正式發行的版本。
  • 貢獻守則「應該」鼓勵採用能在版本控制系統中,輕鬆檢視與瞭解檔案中何處有做出更動的檔案格式。
  • 貢獻者「可選擇」是否對送交內容作簽章,並附上電子郵件信箱,以便當未來貢獻者對其內容有疑問時,可以與之前的貢獻者聯絡。

測試方式

  • 確認程式基底維持在版本控制狀態中,像是使用 Git 之類的軟體。
  • 審查送交版次歷史紀錄,確認所有的送交版次訊息,皆有解釋程式碼修改變動的原因。
  • 審查送交版次歷史紀錄,確認所有送交版次訊息之中,盡可能在所有討論過修改變更的地方,包含變動內容以及連結位置(提供網址)。
  • 檢查版本控制系統是否為分散式。
  • 審查送交版次歷史紀錄,檢查是否有根據貢獻指引將相關的程式碼變動以群組分類。
  • 檢查是否可能透過像是修訂版次標記,或文字標籤,來取用程式基底中的特定版本。
  • 檢查程式基底在盡可能的情況下,檔案都是採用文字格式。

公共政策制定者:需要的工作

  • 如果因為政策改變而在程式基底中有新的版本,則請確認有在文件中清楚說明:
    • 政策改變的地方,
    • 程式基底如何因應而改變。

舉例來說,為程式基底作權限管理時,如果要新增申請方類別來賦予取用權,應視為一種政策變動。

管理人員:需要的工作

  • 支持政策制定者、開發人員與設計師,使其能清楚表達他們對程式基底做出的改善。確保改善程式基底不會有公關風險。

開發人員與設計師:需要的工作

  • 確認版本控制系統中,有瞭解程式碼、建置與部署所需要用到的所有檔案。
  • 送交版次訊息要寫清楚,讓人一看就能瞭解送交修改的原因。
  • 使用像是修訂版次標記,或文字標籤來標示不同版本,以方便取用特定版本。
  • 送交版次訊息要寫清楚,方便之後比較各版本。
  • 在政策改變以後,與政策制定者合作說明原始碼更新的部分。

延伸閱讀