本页面概述了AutoGPT的开发流程,面向希望为项目做出贡献的开发者。它涵盖了开发工作流程、代码库结构以及使用代码库的最佳实践。有关具体的贡献指南,请参阅贡献;有关CI/CD的详细信息,请参阅CI/CD工作流程;有关测试方法,请参阅测试;有关详细的拉取请求流程,请参阅PR流程。
AutoGPT项目遵循标准的GitHub开发工作流程。贡献者会fork代码库,为他们的更改创建分支,并提交拉取请求以供审查和集成。
图示:开发工作流程
AutoGPT代码库组织成不同的区域,每个区域都有特定的目的和贡献要求。
代码库包含两个主要系统
图示:代码库组织结构
提交拉取请求时,开发者应
图示:拉取请求生命周期
来源: .github/PULL_REQUEST_TEMPLATE.md1-38 CONTRIBUTING.md13-23
PR模板有助于确保所有贡献都符合项目标准。以下是主要组成部分的细分:
| 章节 | 目的 |
|---|---|
| 更改 | 对所有更改进行简洁的描述 |
| 清单 | 验证代码质量和测试 |
| 测试计划 | 分步测试方法 |
| 配置更改 | 环境更改文档 |
来源: .github/PULL_REQUEST_TEMPLATE.md1-38 CONTRIBUTING.md13-23
该项目使用自动标签来根据修改的文件对拉取请求进行分类。这有助于维护者识别更改所影响的区域。
图示:自动PR标签
表格:开发领域和注意事项
| 领域 | 关键注意事项 |
|---|---|
| 经典 AutoGPT | 保持与现有功能的兼容性 |
| 平台前端 | 遵循React/Next.js最佳实践,确保响应式设计 |
| 平台后端 | 遵循FastAPI约定,维护正确的API文档 |
| 区块 | 确保适当的隔离,一致的接口 |
| 文档 | 清晰、简洁的解释和示例 |
| 测试 | 为新功能提供全面的测试覆盖 |
AutoGPT项目提供了一些资源来帮助贡献者
对于那些有兴趣在代码贡献之外更深入地参与项目的人来说,“催化”Wiki页面提供了有关项目管理角色的额外信息。
代码库不同部分适用不同的许可条款
在为项目特定区域做出贡献之前,请确保了解许可条款。
有关特定开发主题的更详细信息,请参阅以下页面: