我們非常歡迎您對 Gemini API Cookbook 提交修補程式碼和貢獻。我們很高興您考慮捐贈一些時間,這份指南將幫助我們尊重您的時間。
所有對這個專案的貢獻都必須附上貢獻者授權協議 (CLA)。您(或您的雇主)保留對您的貢獻的版權;這只是給予我們使用和重新分發您的貢獻作為專案的一部分的許可。
如果您或您目前的雇主已經簽署了 Google CLA(即使是為了不同的專案),您可能不需要再次簽署。
請訪問https://cla.developers.google.com/查看您目前的協議或簽署新的協議。
在您開始撰寫之前,請查看技術寫作風格指南。您不需要完全消化整個文件,但請閱讀要點,以便您能預見最常見的反饋。
同時,請查看您將使用的語言的相關風格指南。這些嚴格適用於原始程式碼文件(例如 .py、.js),但在文件(如 markdown 檔案或筆記本)中的程式碼片段通常傾向於可讀性而非嚴格遵守。
對於 Python 筆記本(*.zh.ipynb 檔案),請考慮在筆記本上運行 pyink
。這不是必需的,但它將避免與風格相關的問題。
小修正,例如拼寫錯誤或錯誤修正,可以直接通過拉取請求提交。
在您發送拉取請求之前,或者甚至只寫一行程式碼之前,請先提交一個問題。在那裡,我們可以討論您的請求並提供有關如何結構化您撰寫的任何內容的指導。
添加新指南通常涉及大量詳細的審查,我們希望確保您的想法完全形成並得到全面支持,然後再開始撰寫任何內容。如果您想將現有指南移植(例如,如果您在自己的 GitHub 上有一個 Gemini 的指南),請在問題中提供連結。
在接受新指南時,我們希望平衡幾個方面。
- 原創性 - 例如,是否有另一個做同樣事情的指南?
- 教學性 - 例如,這個指南是否教授了有用的內容?特別是針對 Gemini API 功能?
- 品質 - 例如,這個指南是否包含清晰、描述性的散文?程式碼易於理解嗎?
提交不必在所有這些方面都強大,但越強大越好。舊的提交可能會被新的提交取代,後者超越了這些特性。
如果您從頭開始撰寫了一個新的指南,歡迎您在文件頂部包含您的名字和 GitHub 用戶名的署名。