LangManus 项目贡献指南 - 社区驱动的 AI 自动化框架

欢迎参与 LangManus 项目！我们热烈欢迎来自社区的各种贡献。以下是参与贡献的相关信息：

贡献方式

你可以通过以下方式参与 LangManus 的贡献：

• 代码贡献：添加新功能、修复漏洞或提升性能
• 文档编写：改进 README 文件、添加代码注释或创建示例
• 漏洞报告：通过 issues 提交详细的漏洞报告
• 功能建议：提出新功能或改进建议
• 代码审查：审查其他贡献者的 pull 请求
• 社区支持：在讨论和 issues 中帮助他人

开发环境搭建

1. Fork 仓库：点击 GitHub 页面上的 Fork 按钮，将 LangManus 仓库复制到你的账户下。
2. 克隆仓库：在本地终端中运行以下命令，将代码下载到你的计算机上。

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

1. 设置开发环境：运行以下命令来安装依赖项和配置环境。

uv sync --all-extras
uv run playwright install

1. 配置 pre-commit 钩子：这有助于在提交代码前自动检查代码质量。

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

开发流程

1. 创建新分支：为你的功能或修复创建一个新分支。

git checkout -b feature/amazing-feature

1. 进行代码修改：按照我们的编码标准进行开发：
   • 编写清晰、有注释的代码
   • 遵循 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. 创建 Pull Request：在 LangManus 的 GitHub 页面上，点击“New Pull Request”按钮，按照提示提交你的更改。

Pull Request 指南

• 完整填写 pull request 模板
• 为新功能添加测试
• 根据需要更新文档
• 确保所有测试通过且没有代码风格错误
• 保持 pull request 聚焦于单一功能或修复
• 引用相关的 issues

代码风格

• 遵循 PEP 8 指南
• 尽可能使用类型提示
• 编写描述性的文档字符串
• 保持函数和方法单一且专注
• 对复杂的逻辑添加注释

社区准则

• 保持尊重和包容
• 遵守我们的行为准则
• 帮助他人学习和成长
• 提供建设性的反馈
• 聚焦于改进项目

需要帮助？

如果你在参与过程中遇到任何问题：

• 查看现有的 issues 和讨论
• 加入我们的社区频道
• 在讨论中提问

感谢你为让 LangManus 更好而做出的贡献！