Documentación

Escriba un AGENTS.md para sus agentes y los de Coroid

Un archivo de instrucciones para los asistentes de tus desarrolladores y los agentes de Coroid. Define lo que ambos usan, lo que hace Coroid por sí mismo y cómo mantener un mismo nivel de calidad.

Los asistentes de tus desarrolladores, como Claude Code, Codex y Cursor, y los agentes de Coroid leen el mismo AGENTS.md. La mayor parte sirve para ambos: los comandos, las convenciones y los límites. Lo que no aplica es el flujo de trabajo de Git, ya que Coroid crea la rama, el commit y la solicitud de extracción por sí mismo.

Lo que leen los agentes de Coroid

Antes de cada tarea, los agentes de Coroid leen los archivos de memoria en la raíz del repositorio: AGENTS.md, CLAUDE.md, GEMINI.md y las reglas de Cursor en .cursor/rules. Siguen @ importa, e las instrucciones idénticas se incluyen una sola vez. Elige qué fuentes reciben los agentes en Configuración → Conocimiento → Contexto. Consulta Contexto del proyecto.

Una tarea lee los archivos de su propia copia de trabajo, por lo que un cambio en AGENTS.md aparece en las tareas que comienzan después de que llegue a la rama base.

Lo que sirve para ambos

Escríbelo una vez, para cada agente:

  • Comandos: install, build, test y la prueba más específica útil, como un paquete o un archivo. Verifícalos desde una clonación limpia y nombra el directorio donde ejecutarlos y los servicios que necesitan las pruebas.
  • Convenciones que el código no muestra: nomenclatura, gestión de errores, cómo se traducen las cadenas de texto, qué patrones están prohibidos.
  • Límites: módulos congelados, rutas que pertenecen a un equipo, dependencias que no se deben añadir, archivos que nunca se deben editar manualmente.

Manténlo breve. Cada línea se lee en todas las tareas y por todos los agentes. Enlaza a un documento más largo en lugar de pegarlo y omite lo que el código ya muestra.

Lo que hace Coroid por sí mismo

Los agentes de Coroid modifican archivos en un entorno aislado. Coroid se encarga del resto:

PasoEn Coroid
RamaCoroid crea una por tarea: feature/coroid-<id>-<title>, o bugfix/, refactor/, test/ o docs/ según el tipo de trabajo. Las vías de un plan usan coroid/factory/…
CommitCoroid escribe el mensaje de commit y añade encabezados de procedencia como Coroid-Task. Cuando tu cuenta conectada es la autora, añade Co-authored-by: Coroid <ai@coroid.ai>
EnvíoCoroid envía la rama. El entorno aislado rechaza git push, git pull, git fetch y git clone, y no almacena credenciales para tu proveedor.
Solicitud de extracciónCoroid la abre, con el título basado en la tarea y una descripción que vincula la tarea, sus criterios de aceptación y los resultados de QA y revisión.

Instrucciones como "trabajar en una ws/ rama", "abrir pull request con gh pr create" o "terminar cada commit con una línea de coautor" no aplican dentro de Coroid. Solo los archivos que modifica un agente salen del entorno aislado, por lo que la rama o commit que cree allí se descartan. Coroid lo indica a sus agentes antes de leer tus archivos de instrucciones: omiten esos pasos y siguen el resto.

Nada se confirma en tu rama base: consulta Configuración de repositorio y rama.

Indica qué partes aplican dónde

Los agentes de Coroid ya omiten tu flujo de trabajo de Git. Mencionarlo en el archivo ayuda a todos los lectores, incluidas las personas, y mantiene en un solo lugar un paso exclusivo de Coroid, como una comprobación que ejecutar antes de finalizar. Coloca una sección breve cerca de la parte superior:

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

Luego marca el flujo de trabajo local como lo que es:

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

Los asistentes de tus desarrolladores conservan su flujo de trabajo y nadie tiene que adivinar qué pasos son de quién.

Comprobaciones que deben superar todos los pull request

Una comprobación escrita solo en AGENTS.md se ejecuta cuando un agente decide hacerlo. Los commits de Coroid también omiten los ganchos de Git de tu repositorio, como husky o pre-commit. Una comprobación que debe cumplirse para cada cambio se define en Control de Calidad como Comando de repositorio comprobación:

  • Coroid la ejecuta sobre los cambios que realizan sus agentes.
  • Con las comprobaciones de pull request activadas, también se ejecutan en las solicitudes de extracción que abre tu equipo, incluidas las creadas con Claude Code, Codex o Cursor.

Ambas formas de trabajar cumplen entonces el mismo estándar. Consulta Políticas y controles de calidad.

Para las reglas anti-slop, un asistente de desarrollador puede pedirlas a Coroid mediante MCP. anti_slop_rules devuelve un fragmento que indica las reglas del proyecto para AGENTS.md: consulta Reglas anti-slop desde tu editor.

CI que se ejecuta solo para algunas ramas

Si tu CI o protección de ramas solo se ejecuta para ciertos nombres de rama, añade las de Coroid:

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

De lo contrario, las solicitudes de extracción de Coroid se abrirán sin las comprobaciones en las que confía tu equipo.

Un archivo para cada herramienta

Mantén las instrucciones en un solo lugar, en AGENTS.md:

  • Codex y Cursor leer AGENTS.md.
  • Claude Code lee CLAUDE.md. Conviértelo en una sola @AGENTS.md línea, más cualquier cosa que necesite exclusivamente Claude Code.
  • Cursor también lee sus reglas en .cursor/rules. Coroid las lee mientras Cursor las aplica: consulta Contexto del proyecto.

Coroid lee CLAUDE.md con su función de importación e incluye AGENTS.md una vez.

Comprueba lo que lee Coroid

En Configuración → Conocimiento → Contexto, Fuentes del repositorio enumera cada archivo con un recuento estimado de tokens y un interruptor. Editar abre un archivo allí. Al guardar se abre un pull request en un repositorio conectado, de modo que el cambio pasa por el mismo proceso de revisión que cualquier otro.