工作產品提交指南

在最終評估中，所有參與貢獻者都必須提供自己為計畫完成的工作連結。如未正確操作，可能會導致程式失敗。儲存方法有很多種， 請詳閱本文件，

這些連結將發布在 GSoC 專案的公開封存檔中。這些工具有助於展示計畫期間完成的工作。也是讓未來的雇主參考您的成果的絕佳方式。您希望人員可以快速瞭解專案目標、完成的內容、程式碼位置，以及任何可能的後續步驟。

過去幾年來，我們看到最精彩的「最終報告」範例，內容如下：

  • 專案目標的簡短說明。
  • 你做了什麼。
  • 目前狀態。
  • 還剩下什麼步驟
  • 哪些程式碼已合併 (或未) 上游。
  • 您在專案期間學到的任何挑戰或重要事情。

如要查看範例，請從 2022 年專案清單開始，隨機挑選專案，然後按一下「查看程式碼」。請注意，許多專案並未遵循我們的建議，也就是說，這些專案確實無法如實展現其成果。

貢獻者註意事項：提交最終提交的作業後，在最終提交作業的期限之前，您都可以編輯專案內容。

提交評估作業前，請先與導師分享連結，確保對方符合期待。

需求條件

  • 必須能輕易識別您完成的作品。(也就是您所做的變更或新程式碼)。
    • 當使用者前往提供的網址時，應清楚指出您所執行的項目，且不需他們進行大量額外調查。
  • 裝置應位於穩定的位置。提交後即無法變更網址。
  • 其他人應能使用連結目標中 (或參照) 的內容來擴展工作。
    • 如果作品已完全完成，他們應該可以使用。
    • 如果研究成果未完全完成，您將會知道還剩下哪些部分。

範例

您不必執行所有 (或任一) 操作，但只要滿足以下條件，即可滿足需求。

  • 建立網誌文章或網頁或公開 GitHub 資料庫來說明您完成的工作，並連結至您製作的修訂版本和您所使用的存放區。如果專案尚有需要處理的工作，也請附上相關資訊。此外，你也可以分享精華片段或具有挑戰性的項目。
    • ❗ 是最理想的選項，因為這樣您就可以輕鬆加入許多資訊。這項功能會清楚顯示您所做的努力，也方便他人使用和理解您的程式碼。
  • 如果使用 GitHub，且您的所有工作都涵蓋在單一提取要求中，您可以使用該連結。
    • 請務必提供詳細的提取要求說明。(請參閱上方的網誌文章內容建議)。
    • 請務必在說明中清楚註明這是 Google Summer of Code。
    • 如果提取要求在 GSoC 結束後執行了更多工作，請確保沒有標註最後一個 GSoC 修訂版本。
    • ❗ 必須在同一個地方使用變更記錄、修訂版本清單和審查註解。
  • 如果您的 GitHub 存放區是用於 GSoC 的單一用途，請新增 README.md 並提供更多詳細資訊。
  • 傳送電子郵件給公開封存的開發人員郵寄清單，並附上上述連結。
  • 在 Google 雲端硬碟中建立公開資料夾，並加入您建立的所有修補程式。
  • 使用 Google 試算表建立公開試算表，並列出你所有的修訂版本。
  • 連結至單一錯誤，當中清楚列出作品和任何其他適當資訊。它會追蹤您完成的所有工作。請確保列出所有修訂版本，或以其他方式很容易找到。
  • 連結至變更內容的統合式或情境差異比較。請務必加入標題，說明專案內容和身分，以便其他人使用。

錯誤示例

請避免採取上述行動。

  • 連結至含有整個專案原始碼或工作目錄的 tarball/zipfile。(很多人以前會完成這項操作，但如果使用者想深入瞭解「您的」工作，將毫無助益)。
  • 專案主要來源存放區頂端的連結。
  • 專案原始碼存放區副本的連結。
    • 這樣會難以看出您所做的變更，因為您的作品是與他人混成混亂。
  • 連結至您的 GSoC 專案頁面。
    • 我們已經知道這是什麼了。(例如 https://summerofcode.withgoogle.com/projects/#1234567890)

導師

請協助貢獻者提交適當的程式碼。您必須在最終工作提交期限「之前」執行這項操作。

請確認...

  • 提交內容符合上述規定。
  • 程式碼會編譯。
  • 請參閱說明文件，瞭解應用程式的運作方式與原因。

GSoC 的概念不是由貢獻者放棄程式碼，請務必在託管的開放原始碼專案中提供實用的程式碼。