终极Magentic-UI贡献指南：5步成为开源项目开发高手

【免费下载链接】magentic-ui A research prototype of a human-centered web agent 项目地址: https://gitcode.com/GitHub_Trending/mag/magentic-ui

Magentic-UI是一个以人为中心的Web代理研究原型，作为开源项目，它欢迎所有类型的贡献，无论是错误报告、功能请求、代码提交、文档编写还是帮助他人解答问题。本指南将帮助你快速掌握参与Magentic-UI开发的全过程，从环境搭建到代码提交，让你轻松成为贡献者。

为什么选择贡献Magentic-UI？

Magentic-UI作为一个创新的Web代理项目，具有独特的工作流程和界面设计。它通过规划阶段和执行阶段的协作，结合WebSurfer、Coder和FileSurfer等组件，为用户提供强大的任务处理能力。

参与Magentic-UI的贡献，不仅可以提升你的技术能力，还能参与到前沿的人机交互项目中，为开源社区贡献力量。

贡献前的准备工作

了解行为准则

在开始贡献之前，请务必阅读项目的CODE_OF_CONDUCT.md，了解社区的行为规范。该项目采用了Microsoft开源行为准则，确保社区的友好和包容。

签署贡献者许可协议(CLA)

大多数贡献都需要你同意贡献者许可协议(CLA)，声明你有权授予我们使用你的贡献的权利。当你提交拉取请求时，CLA机器人会自动判断你是否需要提供CLA，并给出相应的指导。你只需按照机器人的指示操作即可，在所有使用我们CLA的仓库中，你只需完成一次。

5步贡献流程

第1步：找到合适的任务

• 浏览项目的所有问题，寻找标有"help-wanted"的问题，这些问题特别适合社区贡献。
• 你也可以帮助审查开放的拉取请求。
• 如果你有新功能或改进的想法，可以打开一个新的问题进行讨论。

第2步： Fork和克隆仓库

首先，Fork项目仓库，然后将其克隆到本地机器：

git clone https://gitcode.com/GitHub_Trending/mag/magentic-ui

第3步：创建分支并开发

• 使用描述性的分支名称，例如fix/session-bug或feature/file-upload。
• 编写代码和测试，确保新功能或错误修复有相应的测试。可以参考tests目录中的示例。

Magentic-UI的前端界面设计直观，让你可以轻松地进行任务规划和执行。下面是项目的 landing 页面，你可以在这里输入任务或尝试示例任务：

在规划阶段，你可以看到系统生成的任务步骤，并根据需要进行调整：

第4步：本地运行检查

在提交拉取请求之前，运行以下命令进行本地检查：

poe check

这将确保你的代码符合项目的规范和质量要求。

第5步：提交拉取请求

• 打开针对main分支的拉取请求。
• 在PR描述中引用问题编号，例如"Closes #123"。
• CLA机器人会指导你是否需要签署CLA。

社区"Help Wanted"热门问题

我们使用绿色的"help-wanted"标签来突出特别适合社区贡献的问题。以下是你可以立即帮助解决的前10个问题：

•  允许MAGUI理解视频和音频 (#132)
•  在UI中启用任意文件上传 (#128)
•  添加最终答案和编码器消息的流式传输 (#126)
•  添加单元测试 (#123)
•  允许网页浏览器在容器内滚动 (#124)
•  组合多个计划 (#129)
•  减少延迟 (#131)
•  改进允许列表 (#125)
•  在前端步骤中添加代理名称 (#110)
•  为浏览器会话传递身份验证信息 (#120)

查看所有需要帮助的问题以获取更多机会。

运行测试和检查

所有贡献都必须通过持续集成检查。在提交PR之前，你可以通过运行以下命令在本地运行这些检查：

poe check

参与代码审查

你也可以通过审查开放的PRs来帮助项目。代码审查是提高代码质量的重要环节，你的反馈和建议将对项目的发展起到重要作用。

遇到问题？

如果你有任何问题，可以打开一个issue或开始讨论。Magentic-UI社区欢迎你的加入，感谢你帮助使Magentic-UI变得更好！

通过本指南，你已经了解了参与Magentic-UI开源项目开发的全部流程。现在就开始你的贡献之旅吧，成为这个创新项目的一部分！ 🚀

【免费下载链接】magentic-ui A research prototype of a human-centered web agent 项目地址: https://gitcode.com/GitHub_Trending/mag/magentic-ui