貢獻指南
感謝您有興趣貢獻於 Agent Development Kit (ADK)!我們歡迎對核心框架(Python 與 Java)以及其文件說明的各種貢獻。
本指南將說明如何參與本專案。
1. google/adk-python¶
包含核心 Python 函式庫的原始碼。
2. google/adk-java¶
包含核心 Java 函式庫的原始碼。
3. google/adk-docs¶
包含您目前正在閱讀的文件說明網站的原始碼。
4. google/adk-web¶
包含 adk web 開發 UI 的原始碼。
開始之前¶
✏️ 簽署貢獻者授權協議(Contributor License Agreement, CLA)¶
對本專案的貢獻必須附帶 貢獻者授權協議(Contributor License Agreement, CLA)。 您(或您的雇主)將保留對您貢獻內容的著作權;這僅僅是授權我們可以將您的貢獻用於本專案並重新發佈。
如果您或您目前的雇主已經簽署過 Google CLA(即使是為其他專案),通常不需要再次簽署。
請造訪 https://cla.developers.google.com/ 以檢視您目前的協議或簽署新的協議。
📜 請閱讀我們的社群指引¶
本專案遵循 Google 開源社群指引。
💬 加入討論!¶
有問題、想分享想法,或想討論您如何使用 ADK?歡迎前往我們的 Python 或 Java 討論區!
這裡是主要的交流場所,適合:
- 向社群與維護者提問並獲得協助。
- 分享您的專案或使用案例(
Show and Tell)。 - 在建立正式議題前,討論潛在的新功能或改進建議。
- 關於 ADK 的一般性討論。
如何貢獻¶
您可以透過以下幾種方式貢獻於 ADK:
1. 回報問題(錯誤與 Bug)¶
如果您發現框架有 bug 或文件說明有錯誤:
- 框架 Bug: 請在
google/adk-python或google/adk-java中提出 issue - 文件錯誤: 在
google/adk-docs中提出 issue(請使用 bug 模板)
2. 建議改進¶
有新功能的想法,或想改善現有功能?
- 框架改進: 請在
google/adk-python或google/adk-java中提出 issue - 文件改進: 在
google/adk-docs中提出 issue
3. 改善文件說明¶
發現有錯字、說明不清楚或資訊遺漏?歡迎直接提交您的修改:
- 方式: 提交 Pull Request (PR) 來建議您的改進。
- 位置: 在
google/adk-docs建立 Pull Request
4. 撰寫程式碼¶
協助修正 bug、實作新功能,或為文件說明貢獻範例程式碼:
方式: 提交包含您程式碼修改的 Pull Request (PR)。
- Python 框架: 在
google/adk-python建立 Pull Request - Java 框架: 在
google/adk-java建立 Pull Request - 文件說明: 在
google/adk-docs建立 Pull Request
程式碼審查¶
-
所有貢獻(包含專案成員的貢獻)都需經過審查流程。
-
我們使用 GitHub Pull Request (PR) 來提交與審查程式碼。請確保您的 PR 清楚描述所做的更動。
授權條款¶
一旦您貢獻內容,即表示您同意您的貢獻將依本專案的 Apache 2.0 授權條款 授權。
有問題嗎?¶
如果您遇到困難或有任何疑問,歡迎在相關儲存庫的 issue tracker 上提出 issue。