@rt-tools/agent-kit 0.3.0 → 0.4.0

package/assets/rules/git-workflow.md

@@ -1,106 +0,0 @@
----
-name: git-workflow
-kind: rule
-law: delivery
-description: Правило под закон «Поставка». Брать на заведение задачи, ветки, коммит, пуш, создание PR, слияние, а также на правку схемы хранилища и её миграций. Задача как начало работы, колонка задачи как ход работы, соответствие задачи и ветки один к одному, формат коммита, обязательный состав PR, сторожевые хуки. Готовый код — в паттернах git-workflow-commit, git-workflow-merge, git-workflow-migration и git-workflow-restart. Чем это названо здесь — в implementation.md рядом.
----
-
-# Поставка — каким приёмом
-
-Правило под закон `{{lawsDir}}/delivery.md`. Закон говорит, что должно быть верно; здесь — каким
-приёмом это держится. Как названы главная ветка, борда, колонки, формат имени ветки и учётная
-запись машинной работы — `implementation.md` рядом.
-
-## Когда берётся
-
-Заведение задачи и ветки, коммит, пуш, открытие PR, слияние, правка схемы хранилища и её
-миграций, ручной перезапуск прода.
-
-## Что здесь действует
-
-- **Коммит в главную ветку отбивается гардом.** Гард ищет вызов коммита в любом месте команды и
-  смотрит текущую ветку на момент запуска, поэтому составная «создать ветку и сразу коммитить»
-  отклоняется целиком: ветки в момент разбора ещё нет.
-- **Ветка без номера задачи PR не открывает.** Локально такая ветка законна, но правка из неё —
-  это выкатка, за которой в очереди работ ничего не стоит.
-- **Номер ветки и номер в заголовке PR сверяются на месте, а состояние задачи — по борде.**
-  Формат читается из текста команды и работает без сети; существование задачи, её присутствие в
-  очереди, исполнитель и то, что она ещё открыта, — только когда есть чем спросить. Нет сети
-  или нет токена — второй ярус молча пропускается: проверка, падающая в самолёте, перестаёт
-  что-либо значить.
-- **Колонка задачи двигается тем же движением, что и работа.** Ветка заведена — задача
-  переставляется во взятые в работу, PR открыт — в разбор. Перевод идёт сразу за шагом, который
-  его вызвал: очередь работ читают между шагами, а не после них.
-- **Отставшая колонка находится сверкой очереди, а не глазами.** Сверка судит колонку по отчёту
-  в обе стороны: открытый PR при задаче не в разборе и разбор без открытого PR — оба
-  расхождения.
-- **Задачи, чинящиеся одной правкой, сливаются до слияния ветки.** Недостающее из поглощённой
-  дописывается в первую, а сама она уходит из очереди. После слияния ветки слить уже нельзя:
-  она въехала, и откатывается целиком.
-- **Слияние в главную ветку выкатывает прод.** Исключения по путям покрывают только документы,
-  поэтому переменные окружения, секреты и записи имён ставятся до слияния, а не после.
-- **Признак режима объявлен в образе, а не только в составе прода.** Значение, заданное
-  составом, действует лишь на контейнер, поднятый этим составом; ручной прогон того же образа
-  идёт с пустым значением, а пусто здесь означает разработку — со всеми отладочными
-  умолчаниями, которые она разрешает.
-- **Образы выкатываются по хешу коммита, а не по метке «последний».** Метка в реестре отстаёт
-  от главной ветки, и прод молча возвращается к прежней версии, продолжая отвечать.
-- **Цепочка миграций прогоняется с пустого хранилища до слияния.** Порядок применения
-  лексикографический по имени каталога, а метку времени ставит момент создания: миграция из
-  ветки, начатой раньше, встаёт перед той, от которой зависит.
-- **Документ едет в том же коммите, что и правка.** Обход — отметка с причиной в теле коммита;
-  пустая причина не принимается.
-- **Заголовок коммита сверяется с форматом на месте.** Разобранный по типу и области заголовок
-  читается списком, а свободный текст — только целиком.
-- **Перед пушем прогоняются все линтеры, а не один.** Линтер кода обычно не читает файлы стилей
-  вовсе, и правила оформления без второго прогона не проверяет ничто.
-
-## Паттерны
-
-- `git-workflow-commit` — ветка, коммит, пуш и PR от учётной записи машинной работы.
-- `git-workflow-merge` — влить главную ветку в ветку задачи и разрешить конфликт.
-- `git-workflow-migration` — файл миграции и прогон цепочки на одноразовом хранилище.
-- `git-workflow-restart` — ручной перезапуск прода без отката на прежний образ.
-
-## Ловушки
-
-- **Одна работа — одна задача, сколько бы файлов она ни задела.** Числа, за которым правка
-  становится второй задачей, нет: делится то, что придётся откатывать порознь. Сплошная правка,
-  разделённая «по объёму», кончается стиранием лишних задач, закрытием их PR и переносом
-  коммитов с конфликтами.
-- **Задача заводится одной командой, а не набором вызовов подряд.** Очередь работ к репозиторию
-  обычно не привязана, и задача попадает в неё только явным добавлением: переписанный руками
-  шаг оставляет её вне очереди, и заметить это нечем.
-- **Ветка заводится вторым вызовом, а не тем же.** Гард главной ветки отклоняет составную
-  «создать ветку и сразу коммитить» целиком.
-- **Колонка, приведённая в порядок задним числом, ничего не значила ровно тогда, когда очередь
-  читали.** Перевод стоит одной команды и делается на месте, а не собирается в уборку под
-  конец: очередь для того и ведётся, чтобы отвечать в любой момент.
-- **Сторона конфликта бывает удалением, и «сохранить обе стороны» заводит второе объявление.**
-  Главная ветка снимает объявление, потому что символ переехал, — в конфликте это выглядит как
-  сторона, которая ничего не дописала. Разбирается чтением версии главной ветки целиком, а не
-  по куску: обе копии сами по себе исправны, сборка и линтер зелёные.
-- **Конфликт при вливании главной ветки почти всегда лежит в текстах, а не в коде.** Соседние
-  ветки дописывают в конец одних и тех же списков; зелёная сборка после слияния про такой
-  конфликт не говорит ничего.
-- **PR без ревьювера, исполнителя и меток открывать нельзя.** Ревьювер не узнаёт, что его ждут,
-  а метки — единственное, по чему в очереди из полутора десятков PR видно род правки и её
-  область.
-- **Заголовок PR без номера задачи не сопоставить с очередью.** В списке PR тела не видно, а
-  строка о закрытии задачи живёт именно там. Название при этом идёт в сделанном: задача просит
-  исправить, PR отчитывается, что исправлено.
-- **На самом PR не гоняется ничто.** Выкатка запускается пушем в главную ветку, и выборочный
-  прогон по затронутому до PR не доходит: сборки, проверки текстов и браузер идут до
-  публикации.
-- **Субагентам работа с историей запрещена полностью, включая чтение состояния.** Отложенные
-  изменения, спрятанные субагентом, выглядят как потеря всей работы. Историю ведёт главный
-  агент.
-- **Подъём контейнера без явного тега образа подставляет «последний».** Приложение при этом
-  отвечает, и подмену видно только по пропавшим строкам нового кода в журнале.
-- **Команда разработчика для миграций на живом хранилище не запускается.** Любое расхождение
-  состояния она лечит предложением сбросить хранилище, а в нём лежат данные владельца.
-- **Переименованная миграция остаётся в хранилище под прежним именем.** Накат падает на «объект
-  уже существует» и лечится отметкой о применении, а не повторным накатом.
-- **Флаги инструмента миграций не те, что в примерах из сети.** На неизвестный флаг команда
-  печатает справку, а не строку ошибки, — промах виден только в ней. Какие флаги есть сейчас,
-  смотрят в её собственной справке, а не в этом тексте.