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

Запустите свою первую задачу

Опишите задачу, утвердите план и наблюдайте, как Coroid её реализует и проверит.

Задача — задача — это единица работы, результатом которой становится один pull request. Начните её создание из Новая работа.

Выберите подходящую первую задачу

Лучшая первая задача — небольшая, реальная и связанная с существующими тестами. Например: «Добавить --json флаг в команду экспорта, чтобы структура вывода совпадала с форматом, который уже принимает команда импорта» — так у Coroid будет чёткая цель, а у вас — явное представление о результате.

Во время первого запуска избегайте следующего:

  • всего, что касается аутентификации, платежей или миграции данных
  • работы, для которой требуется принятие решения по дизайну, ещё не принятое вами
  • Неточные формулировки вроде «улучшить обработку ошибок» не имеют чёткой границы завершения.

Опишите желаемый результат.

Укажите итоговый результат, а не способ его достижения. Опишите, что должно быть реализовано по завершении задачи, а также упомяните всё неочевидное: важные файлы, применяемые стандарты, элементы, которые трогать нельзя.

Вам не нужно составлять план вручную. Именно это и создаёт Coroid, после чего вы можете его одобрить.

Если есть контекст, который не отражён в коде — решение по архитектуре, руководство по стилю, задача в трекере — прикрепите его. Подробнее в разделе Контекст проекта — там указано, что уже известно Coroid, без дополнительных пояснений.

Просмотрите спецификацию.

Coroid преобразует ваше описание в спецификацию: что именно будет создано, что не входит в область задачи, а также критерии приемки, определяющие успешное выполнение. Эта информация отображается на вкладке «Спецификации» соответствующей задачи.

Прочитайте их перед началом разработки. Если критерии приемки не соответствуют вашим ожиданиям, исправьте их сейчас — именно по ним будет проводиться проверка на следующем этапе. Подробнее в разделе Спецификации.

Утвердить план

Для задач сложнее простых изменений спецификации превращаются в план: упорядоченный набор шагов. Вы утверждаете его перед написанием кода.

Это самый экономичный момент для корректировок. Отклонение плана займет у вас всего минуту, а отклонение готового pull request потребует повторной обработки всего процесса.

Наблюдать за выполнением

После утверждения задача попадает в PENDING до освобождения слота агента, после чего IN_PROGRESS. Вы можете отслеживать процесс в реальном времени: выполняемые шаги, вызываемые инструменты, изменяемые файлы и результаты тестов по мере их накопления.

Вам не обязательно следить за процессом. Уведомления сообщат вам, когда потребуется ваше участие или когда задача будет завершена.

Чего ожидать

  • Продолжительность определяется объемом изменений и временем выполнения вашего набора тестов, a не количеством доступных слотов агентов. Слоты определяют, сколько задач может выполняться одновременно.
  • NEEDS_HUMAN_REVIEW не является сбоем. Это означает, что Coroid запросил решение, которое может принять только вы. Ответьте на запрос — и задача продолжит выполнение.
  • Доработки — это нормально. Если рецензент найдет ошибки, задача вернется к разработчику до того, как попадет к вам на рассмотрение.

Далее

Рецензировать и объединить результат — что поступит в итоге и на что обратить внимание.