Документация

Создайте AGENTS.md для ваших агентов и Coroid

Один файл инструкций для помощников разработчиков и агентов Coroid. То, что используют обе стороны, то, что делает сам Coroid, и как поддерживать единый уровень качества.

Помощники разработчиков, такие как 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 открывает его, название берётся из задачи, а описание содержит ссылку на задачу, критерии приемки, результаты проверки и рецензирования.

Инструкции вроде «работать в ветке „» 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.

Таким образом, оба подхода соответствуют одному стандарту. См. Политики и этапы контроля качества.

Для правил против некачественного кода помощник разработчика может запросить их у Coroid через MCP. 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 в подключённом репозитории, благодаря чему изменение проходит через тот же процесс проверки, что и любые другие правки.