Documentação

Escreva um AGENTS.md para os seus agentes e Coroid's

Um arquivo de instruções para os assistentes dos seus desenvolvedores e para os agentes do Coroid. Define o que ambos usam, o que o próprio Coroid faz e como manter um padrão de qualidade único.

Os assistentes dos seus desenvolvedores, como Claude Code, Codex e Cursor, e os agentes do Coroid leem o mesmo AGENTS.md. A maior parte serve para ambos: os comandos, as convenções e os limites. A parte que não serve é o fluxo de trabalho Git, pois o próprio Coroid cria o branch, o commit e o pull request.

O que os agentes do Coroid leem

Antes de cada tarefa, os agentes do Coroid leem os arquivos de memória na raiz do repositório: AGENTS.md, CLAUDE.md, GEMINI.md e as regras do Cursor em .cursor/rules. Eles seguem @ imports, e as instruções idênticas são incluídas uma única vez. Escolha quais fontes os agentes recebem em Configurações → Conhecimento → Contexto. Veja Contexto do projeto.

Uma tarefa lê os arquivos do seu próprio checkout, portanto uma alteração em AGENTS.md aplica-se às tarefas que começam após alcançar o branch base.

O que serve para ambos

Escreva essas instruções uma única vez, para todos os agentes:

  • Comandos: install, build, test e o teste mais específico possível, como um pacote ou um arquivo. Verifique-os a partir de um clone limpo e indique o diretório onde executá-los e os serviços necessários para os testes.
  • Convenções que o código não revela: nomenclatura, tratamento de erros, como as strings são traduzidas e quais padrões são proibidos.
  • Limites: módulos congelados, caminhos de propriedade da equipe, dependências que não devem ser adicionadas e arquivos que nunca devem ser editados manualmente.

Seja breve. Cada linha é lida em todas as tarefas, por todos os agentes. Prefira linkar para um documento mais longo em vez de colar o conteúdo e omita o que o código já mostra.

O que o próprio Coroid faz

Os agentes do Coroid alteram arquivos em uma área isolada. O restante é feito pelo Coroid:

EtapaNo Coroid
BranchO Coroid cria um por tarefa: feature/coroid-<id>-<title>, ou bugfix/, refactor/, test/ ou docs/ conforme o tipo de trabalho. As faixas de um plano usam coroid/factory/…
CommitO Coroid escreve a mensagem de commit e adiciona trailers de procedência como Coroid-Task. Quando sua conta conectada é o autor, ele adiciona Co-authored-by: Coroid <ai@coroid.ai>
PushO Coroid envia o branch. A área isolada recusa git push, git pull, git fetch e git clone, e não armazena credenciais do seu provedor.
Pull requestO Coroid abre o pull request, com título baseado na tarefa e descrição que vincula a tarefa, seus critérios de aceitação e os resultados de QA e revisão.

Instruções como "trabalhe em um ws/ branch", "abra o pull request com gh pr create" ou "termine cada commit com uma linha de coautor" não se aplicam dentro do Coroid. Apenas os arquivos alterados por um agente saem da área isolada; portanto, um branch ou commit criado lá é descartado. O Coroid avisa seus agentes sobre isso antes de ler seus arquivos de instruções: eles pulam essas etapas e seguem o restante.

Nada é commitado no seu branch base: veja Configurações de repositório e branch.

Indique quais partes se aplicam onde

Os agentes do Coroid já ignoram o seu fluxo de trabalho Git. Incluir essa informação no arquivo ajuda todos os leitores, inclusive pessoas, e mantém uma etapa exclusiva do Coroid, como uma verificação a ser executada antes do fim, em um só lugar. Coloque uma seção curta no início:

## 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`.

Depois, marque o fluxo de trabalho local como tal:

## 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`.

Os assistentes dos seus desenvolvedores mantêm seu próprio fluxo de trabalho, e ninguém precisa adivinhar quais etapas pertencem a quem.

Verificações que todo pull request deve passar

Uma verificação escrita apenas em AGENTS.md é executada quando um agente decide rodá-la. Os commits do Coroid também ignoram os Git hooks do seu repositório, como husky ou pre-commit. Uma verificação que deve valer para toda alteração deve estar em Controle de Qualidade como um Comando de repositório verificação:

  • O Coroid a executa nas alterações feitas por seus agentes.
  • Com as verificações do pull request ativadas, elas também são executadas nos pull requests abertos pela sua equipe, incluindo aqueles criados com Claude Code, Codex ou Cursor.

Dessa forma, ambas as formas de trabalho atendem ao mesmo padrão. Veja Políticas e portas de qualidade.

Para as regras anti-slop, um assistente de desenvolvedor pode solicitá-las ao Coroid via MCP. anti_slop_rules retorna um trecho que define as regras do projeto para AGENTS.md: veja Regras anti-slop do seu editor.

CI que roda apenas para alguns branches

Se a sua CI ou proteção de branch roda apenas para alguns nomes de branch, adicione os do Coroid:

feature/coroid-*
bugfix/coroid-*
refactor/coroid-*
test/coroid-*
docs/coroid-*
coroid/factory/**

Caso contrário, os pull requests do Coroid serão abertos sem as verificações das quais sua equipe depende.

Um arquivo para cada ferramenta

Mantenha as instruções em um único lugar, em AGENTS.md:

  • Codex e Cursor ler AGENTS.md.
  • Claude Code lê CLAUDE.md. Torne-o uma única @AGENTS.md linha, mais qualquer coisa que o Claude Code precise.
  • Cursor também lê suas regras em .cursor/rules. O Coroid as lê conforme o Cursor as aplica: veja Contexto do projeto.

O Coroid lê CLAUDE.md com sua importação e inclui AGENTS.md uma vez.

Verifique o que o Coroid lê

Em Configurações → Conhecimento → Contexto, Fontes do repositório lista cada arquivo com uma contagem estimada de tokens e uma opção de alternância. Editar abre um arquivo lá. Salvar abre um pull request em um repositório conectado, para que a alteração passe pelo mesmo processo de revisão que qualquer outra.