Sweep 使用教程

Sweep是一款AI驱动的GitHub Issue自动解决工具，能将GitHub Issue自动转化为Pull Request，支持Bug修复、功能开发、代码重构等多种任务类型，深度集成GitHub工作流。 快速开始 1. 访问Sweep官方网站，使用GitHub账号登录并授权。 2. 选择你要安装Sweep的仓库，点击Install按钮完成GitHub App的安装。 3. 安装完成后，在仓库的任意一个Issue中添加sweep标签，Sweep就会自动开始工作。 4. 首次使用建议先在一个测试Issue上体验，了解Sweep的工作流程和输出质量。 5. 在仓库根目录创建sweep.yaml配置文件，可以自定义Sweep的行为偏好，如代码风格、测试要求等。 核心功能演示 功能一：自动修复Bug 在GitHub中创建一个Issue，标题写清楚问题现象，描述中提供复现步骤和错误信息。例如标题为登录页面输入邮箱后点击提交按钮无反应，描述中附上控制台报错信息。然后给Issue加上sweep标签，Sweep会自动分析代码库，定位问题原因，编写修复代码并提交PR。整个过程通常在几分钟内完成。 功能二：自动实现功能需求 对于新功能开发，在Issue中清晰描述需求即可。例如添加一个用户头像上传功能，支持jpg和png格式，文件大小限制2MB。Sweep会理解需求，规划实现方案，编写相关代码，包括前端组件、后端接口和必要的测试。它会生成一个完整的PR，包含详细的变更说明。 功能三：代码重构 当需要对某段代码进行重构时，在Issue中描述重构目标，比如将用户认证模块从回调方式改为async/await。Sweep会分析现有代码结构，安全地进行重构，同时保持功能不变，并添加必要的测试来验证重构的正确性。 实际使用案例 场景一：快速修复开源项目Issue 维护一个有多个贡献者的开源项目，经常收到用户报告的Bug。以前需要手动排查和修复，现在将Bug报告标记为sweep，Sweep会在几分钟内生成修复PR，维护者只需审查和合并即可。这大大加快了Issue的处理速度，提升了社区满意度。 场景二：批量处理技术债 项目中积累了不少技术债，如需要替换的废弃API、需要更新的依赖版本等。将这些任务逐个创建为Issue并标记sweep，Sweep会并行处理，生成多个PR。团队只需集中审查，原本需要数天的重构工作可以压缩到几小时内完成。 常见问题FAQ Q：Sweep生成的代码质量如何？ A：Sweep会尽量遵循仓库现有的代码风格和最佳实践，生成的代码通常具有较好的质量。但AI生成的代码仍需人工审查，建议在合并PR前仔细检查变更内容和测试结果。 Q：Sweep支持哪些编程语言和框架？ A：Sweep支持大多数主流编程语言和框架，包括JavaScript、TypeScript、Python、Java、Go等。它会根据仓库中已有的技术栈自动适配。 Q：Sweep能处理多复杂的任务？ A：Sweep适合处理范围明确、描述清晰的中等复杂度任务。过于模糊或涉及重大架构变更的任务可能需要人工拆分为更小的子任务后再交给Sweep处理。 小贴士 1. Issue描述越详细，Sweep的表现越好。提供文件路径、错误堆栈、期望行为等信息，能帮助Sweep更准确地理解问题。 2. 善用sweep.yaml配置文件。可以在其中设置代码风格偏好、排除特定目录、指定测试框架等，让Sweep的输出更贴合项目要求。 3. 对于复杂任务，建议先让Sweep生成方案而非直接写代码。在Issue中说明请先分析问题并给出实现方案，审查方案后再决定是否让它继续编写代码。