通用指南

以下是針對所有類型貢獻需要記住的一些事項

• 遵循 「fork 和 pull request」 工作流程。
• 在開啟 pull request 時，填寫已簽入的 pull request 範本。註記相關問題並標註相關維護者。
• 在請求審核之前，請確保您的 PR 通過格式化、程式碼檢查和測試檢查。
  • 如果您希望對您目前的進度提供意見或回饋，請開啟 issue 或 discussion 並標註維護者。
  • 請參閱關於 測試 和 格式化和程式碼檢查 章節，了解如何在本地端執行這些檢查。
• 向後相容性是關鍵。除非是嚴重的錯誤和安全性修復，否則您的變更不得具有破壞性。
• 在開啟新的 PR 或 issue 之前，請尋找是否已經開啟了重複的 PR 或 issue。
• 盡可能保持範圍隔離。一般來說，您的變更不應影響超過一個套件。

錯誤修復

我們鼓勵並感謝錯誤修復。我們要求您

• 詳細解釋錯誤，以便維護者能夠重現它。
  • 如果存在相關的 issue，請連結到它。以 Fixes 作為前綴，以便在 PR 合併時自動關閉 issue。
• 盡可能避免破壞性變更。
• 包含在沒有錯誤修復時會失敗的單元測試。

如果您遇到錯誤但不知道如何修復，我們要求您開啟一個 issue，詳細描述您遇到錯誤的環境。

新功能

我們旨在對新功能保持高標準。一般來說，如果沒有現有的 GitHub discussion 或 issue 證明有迫切需要，我們不接受外部貢獻者提出的新核心抽象、基礎架構變更、依賴項變更或新的 agent/chain。

• 新功能必須附帶文件、單元測試和（如果適用）整合測試。
• 新的整合必須附帶文件、單元測試和（如果適用）整合測試。
  • 有關貢獻新整合的更多詳細資訊，請參閱此頁面。
• 新功能不應繼承或使用已棄用的方法或類別。
• 我們將拒絕可能導致安全漏洞或報告的功能。
• 請勿新增任何硬性依賴項。整合可以新增可選的依賴項。