开源开发
贡献指南
如何参与 Monkeys 开源项目贡献
Monkeys 欢迎文档、前端、后端服务、部署、工具和 Worker 相关贡献。因为生态已经拆成多个仓库，第一步是选择正确的职责仓库。
1. 选择职责仓库
使用 仓库结构 定位代码归属。
常见例子：
- UI 和 Studio 工作流：
monkeys-studio - 后端工作流 API、模型调用、工具注册、指标：
monkeys-server - Agent 运行时：
monkeys-agent-server - 本地部署参考：
monkeys - 公共文档：
monkeys-docs - 工具服务行为：对应的
monkey-tools-*仓库
2. 搭建本地环境
前后端代码改动请使用 本地开发。
端到端部署验证请使用 从 0 到 1 部署 或 Docker Compose。
3. 使用聚焦分支
git checkout -b feat/short-description每个 pull request 尽量聚焦。好的贡献一次只改变一个产品行为、一个服务边界或一个文档主题。
4. 遵循本地项目命令
每个仓库拥有自己的命令。常见仓库如下：
| 仓库 | 常用检查 |
|---|---|
monkeys-server | yarn build、yarn lint、yarn test，必要时运行 yarn test:e2e |
monkeys-studio | yarn build、yarn lint、yarn test |
monkeys-docs | yarn format:check、yarn build |
如果仓库存在 AGENTS.md，改动前先阅读。里面可能包含本地架构规则、测试预期或生成文件约束。
5. 数据库变更
monkeys-server 涉及表结构变化时需要 migration：
yarn migration:create
yarn migration:run生成后重命名 migration 文件和 class，让名称能描述变更。新建表名应使用 config.server.appId 作为前缀。
6. 文档变更
公共文档中的仓库地址应使用 https://github.com/infmonkeys/...。
文档应聚焦产品行为、部署、开发和贡献。避免向公共文档增加一次性的案例文章或私有运维笔记。
7. Pull Request 检查清单
提交 pull request 前确认：
- 职责仓库选择正确。
- 与改动仓库相关的命令已通过。
- 新行为有聚焦测试，或有清楚的手动验证说明。
- 配置示例不包含密钥。
- 公共链接使用
infmonkeysGitHub 组织。 - 文档和代码中的服务名、端口、仓库边界一致。