开发者的助手,比如Claude Code、Codex和Cursor,以及Coroid的智能体读取相同的AGENTS.md。其中大部分内容对两者都适用:命令、约定和边界规则。唯一不适用的部分是Git工作流,因为Coroid会自行创建分支、提交代码并生成拉取请求。
Coroid的智能体读取的内容
每个任务开始前,Coroid的智能体会读取仓库根目录下的记忆文件:AGENTS.md、CLAUDE.md、GEMINI.md以及Cursor的规则.cursor/rules。它们会遵循@导入的内容,相同的指令只会包含一次。可在
设置 → 知识 → 上下文中选择智能体接收的源文件。设置 → 知识 → 上下文。请参阅项目上下文。
任务会读取其检出版本中的文件,因此对AGENTS.md的修改仅适用于它合并到基础分支后启动的任务。
对两者都适用的内容
这些内容只需为所有智能体编写一次:
- 命令:install、build、test,以及最精简的测试项,比如单个包或单个文件。需在干净克隆环境中验证这些命令,同时注明执行命令的目录以及测试所需的服务。
- 代码中未体现的约定:命名规则、错误处理方式、字符串翻译规范,以及禁止使用的代码模式。
- 边界规则:冻结的模块、团队负责的路径、禁止添加的依赖项,以及严禁手动编辑的文件。
内容要简洁。每行内容会被每个任务、每个智能体读取。无需直接粘贴长文档,可链接到相关文档,代码中已体现的内容无需重复说明。
Coroid自身的功能
Coroid的智能体会在沙盒中修改文件。其余工作由Coroid完成:
| 步骤 | 在Coroid中 |
|---|---|
| 分支 | Coroid会为每个任务创建一个分支:feature/coroid-<id>-<title>,或者bugfix/、refactor/、test/或者docs/具体类型取决于工作任务。计划的车道会使用coroid/factory/… |
| 提交 | Coroid会编写提交信息,并添加诸如来源尾注之类的Coroid-Task的来源描述尾注。若你的账号是提交作者,还会添加Co-authored-by: Coroid <ai@coroid.ai> |
| 推送 | Coroid会推送该分支。沙盒会拒绝git push、git pull、git fetch和git clone,且不会存储你所用服务提供商的凭证。 |
| 拉取请求 | Coroid会打开拉取请求,标题与任务对应,描述中会关联任务、验收标准以及QA和审核结果。 |
诸如“在ws/分支上开展工作”、“打开pull request并gh pr create”或者“每个提交末尾添加合著者行”之类的指令在Coroid内不适用。只有智能体修改的文件才会离开沙盒,因此其在沙盒中创建的分支或提交会被丢弃。Coroid会在读取你的指令文件前告知智能体这些规则:它们会跳过这些步骤,继续执行后续内容。
没有任何内容会被提交到你的基础分支:请参阅仓库和分支设置。
说明哪些内容适用于哪些场景
Coroid的智能体本就会跳过你的Git工作流。在文件中说明这一点有助于所有读者理解,也能将仅适用于Coroid的步骤(比如完成任务前的检查)集中管理。可在文件顶部添加简短说明:
## Working in Coroid
When you run inside Coroid, Coroid creates the branch, commits, pushes and
opens the pull request. Change files only, and skip "Git workflow" below.
Before you finish, run `npm run validate`.然后标注本地工作流的属性:
## Git workflow (local agents)
- Branch: `ws/<nn>-<name>` from `main`, in your own worktree.
- Commit messages end with your assistant's co-author line.
- Run `npm run check:local`, then open the pull request with `gh pr create`.开发者的助手会保留自己的工作流程,无需猜测哪些步骤属于谁。
pull request必须通过的检查项
仅在AGENTS.md中编写的检查项,会在智能体决定运行时被执行。Coroid的提交也会跳过你仓库中的Git钩子,比如husky或pre-commit。需对所有变更生效的检查项应设置在Quality Control作为仓库命令检查项:
- Coroid会对智能体做出的修改运行该检查项。
- 开启pull request检查功能后,它也会对你的团队打开的拉取请求运行该检查,包括用Claude Code、Codex或Cursor编写的拉取请求。
两种工作方式最终都会满足同一质量标准。请参阅质量政策和门槛。
针对反冗余规则,开发者助手可通过MCP向Coroid查询相关内容。anti_slop_rules会返回一段说明项目相关规则的片段,用于AGENTS.md:请参阅编辑器中的反冗余规则。
仅针对部分分支运行的CI
如果你的CI或分支保护机制仅针对特定分支名称运行,需添加Coroid的分支规则:
feature/coroid-*
bugfix/coroid-*
refactor/coroid-*
test/coroid-*
docs/coroid-*
coroid/factory/**否则Coroid生成的拉取请求将不会触发团队依赖的检查项。
每种工具对应的单独文件
将所有指令统一保存在AGENTS.md:
- Codex和Cursor阅读
AGENTS.md。 - Claude Code读取
CLAUDE.md。将其合并为单行@AGENTS.md,仅包含Claude Code所需的任何内容。 - Cursor同样会读取其规则于
.cursor/rules。Coroid会读取这些规则, 正如Cursor应用它们一样:详见项目上下文。
Coroid读取CLAUDE.md并通过其导入功能包含AGENTS.md一次。
查看Coroid读取的内容
在设置 → 知识库 → 上下文、代码仓库源列出每个文件 及其预估的词元数量和一个开关。编辑会在该处打开文件。保存后 会在连接的代码仓库上创建一个pull request,因此该更改会经过 与其他更改相同的审核流程。