LangManus 項目貢獻指南 - 社區(qū)驅動的 AI 自動化框架

歡迎參與 LangManus 項目！我們熱烈歡迎來自社區(qū)的各種貢獻。以下是參與貢獻的相關信息：

貢獻方式

你可以通過以下方式參與 LangManus 的貢獻：

• 代碼貢獻：添加新功能、修復漏洞或提升性能
• 文檔編寫：改進 README 文件、添加代碼注釋或創(chuàng)建示例
• 漏洞報告：通過 issues 提交詳細的漏洞報告
• 功能建議：提出新功能或改進建議
• 代碼審查：審查其他貢獻者的 pull 請求
• 社區(qū)支持：在討論和 issues 中幫助他人

開發(fā)環(huán)境搭建

1. Fork 倉庫：點擊 GitHub 頁面上的 Fork 按鈕，將 LangManus 倉庫復制到你的賬戶下。
2. 克隆倉庫：在本地終端中運行以下命令，將代碼下載到你的計算機上。

git clone https://github.com/your-username/langmanus.git
cd langmanus

1. 設置開發(fā)環(huán)境：運行以下命令來安裝依賴項和配置環(huán)境。

uv sync --all-extras
uv run playwright install

1. 配置 pre-commit 鉤子：這有助于在提交代碼前自動檢查代碼質量。

chmod +x pre-commit
ln -s ../../pre-commit .git/hooks/pre-commit

開發(fā)流程

1. 創(chuàng)建新分支：為你的功能或修復創(chuàng)建一個新分支。

git checkout -b feature/amazing-feature

1. 進行代碼修改：按照我們的編碼標準進行開發(fā)：
   • 編寫清晰、有注釋的代碼
   • 遵循 PEP 8 風格指南
   • 為新功能添加測試
   • 根據需要更新文檔

1. 運行測試和檢查：確保你的代碼通過所有測試和檢查。

make test      # 運行測試
make lint      # 運行代碼風格檢查
make format    # 格式化代碼
make coverage  # 檢查測試覆蓋率

1. 提交更改：將你的更改提交到本地倉庫。

git commit -m 'Add some amazing feature'

1. 推送到遠程倉庫：將你的分支推送到 GitHub 上的個人倉庫。

git push origin feature/amazing-feature

1. 創(chuàng)建 Pull Request：在 LangManus 的 GitHub 頁面上，點擊“New Pull Request”按鈕，按照提示提交你的更改。

Pull Request 指南

• 完整填寫 pull request 模板
• 為新功能添加測試
• 根據需要更新文檔
• 確保所有測試通過且沒有代碼風格錯誤
• 保持 pull request 聚焦于單一功能或修復
• 引用相關的 issues

代碼風格

• 遵循 PEP 8 指南
• 盡可能使用類型提示
• 編寫描述性的文檔字符串
• 保持函數和方法單一且專注
• 對復雜的邏輯添加注釋

社區(qū)準則

• 保持尊重和包容
• 遵守我們的行為準則
• 幫助他人學習和成長
• 提供建設性的反饋
• 聚焦于改進項目

需要幫助？

如果你在參與過程中遇到任何問題：

• 查看現(xiàn)有的 issues 和討論
• 加入我們的社區(qū)頻道
• 在討論中提問

感謝你為讓 LangManus 更好而做出的貢獻！