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

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

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

Задача Задача — это единица работы, результатом которой становится один pull request. Начните создавать её отсюда Новая работа, и выберите Задача в разделе Создать как. Если оставить его на Автоматический режиме, Coroid сам определит, создавать ли задачу или план.

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

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

Чего стоит избегать при первом запуске:

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

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

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

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

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

Новая задача
Опишите желаемый результат. Coroid найдёт оптимальный способ его реализации.
Создать как
АвтоматическиЗадачаПлан
Coroid определяет тип результата, либо вы можете выбрать его самостоятельно.
Проект
web-app
Название работы
Позволить клиентам экспортировать свои счета-фактуры в формате CSV
Краткое описание

Финансовые отделы постоянно просят предоставлять счета в виде таблицы. Добавьте кнопку экспорта в списке счетов, которая сохранит текущий фильтр в формате CSV.

Готово, если: файл открывается в Excel и Numbers, суммы указаны в валюте счёта, а экспорт более 10 000 строк не приводит к превышению времени ожидания.

Прикрепить файлы
Далее: проверка. Ничего ещё не создано.Продолжить

Форма «Новая работа»: выберите, что создать, укажите проект, затем опишите результат в заголовке и кратком описании.

Продолжите процесс квалификации.

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

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

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

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

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

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

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

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

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

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

Чего ожидать

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

Далее

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