av
de12a4d8a3
Каталоги, агенты и общие дома переехали в av-dev/; скиллы названы по прежнему плагину — doc-*, task-*, code-*, с двумя смысловыми именами вместо тавтологии: doc-sync вместо docs, task-track вместо tasks. Манифесты сведены к двум плагинам. Пространства имён вызовов и пути внутри дерева переписаны машинно; проза, которая называет прежние плагины отдельными, идёт следующим шагом.
104 lines
8.7 KiB
Markdown
104 lines
8.7 KiB
Markdown
# Контракт находок
|
||
|
||
Единый формат для всех проходов конвейера ревью. Проход, нарушивший контракт,
|
||
считается сломанным — триаж вправе выбросить его вывод целиком.
|
||
|
||
## Форма находки
|
||
|
||
```
|
||
### <краткая формулировка ПОСЛЕДСТВИЯ, не симптома>
|
||
- Файл: internal/<пакет>/<файл>.go:120-134
|
||
- Severity: critical | major | minor | nit
|
||
- Confidence: high | medium | low
|
||
- Оракул: <падающий тест / команда с выводом / положение руководства / нет>
|
||
- Последствие: <что произойдёт и при каких условиях>
|
||
- Предложение: <конкретное изменение>
|
||
- Найдено проходом: <имя агента; у проходов с раздельными потолками — имя и половина, например `code/техника`>
|
||
```
|
||
|
||
## Правила
|
||
|
||
- **Заголовок через последствие.** Не «нет проверки токена», а «читатель без
|
||
токена выгрузит всю историю». Не «слияние перезаписывает запись», а «повторная
|
||
доставка сотрёт поля у уже сохранённой записи, и восстановить их нечем».
|
||
Симптом в заголовке — это заявка на то, что читатель сам достроит последствие;
|
||
он не достроит, он просто починит симптом.
|
||
- **`critical` без оракула или построенного пути не существует.** Оракул — это
|
||
падающий тест, вывод выполненной команды или поимённое положение руководства. Не
|
||
«вероятно, здесь гонка», а прогон детектора гонок с его выводом.
|
||
- **`confidence: low` — это «так обычно пишут».** Такие находки допустимы, но не
|
||
поднимаются выше `minor`. Частотность конструкции в публичном коде — не
|
||
аргумент.
|
||
- **Находка без поля «Последствие» не выводится вовсе.** Пустое «Последствие:
|
||
ухудшает читаемость» равносильно отсутствию поля.
|
||
- **`nit` допустим только при нарушении записанной конвенции** — со ссылкой на
|
||
файл и раздел конвенций проекта (`docs/conventions/`) либо на
|
||
правило линтера. Если правило механизируемо, но не механизировано — это не
|
||
находка ревью, это `Promote candidate` (см. [promote.md](promote.md)).
|
||
- **`critical` по основанию «нарушен инвариант проекта» требует инвариантов.**
|
||
Ссылка идёт на пункт раздела инвариантов `CLAUDE.md` дословно. Без них основание
|
||
недоступно — см. [project-facts.md](project-facts.md), поразрядная деградация.
|
||
- **Расхождение — не дефект, пока не названо последствие.** Особенно для
|
||
архитектурного прохода: «я бы сделал иначе» без последствия не выводится.
|
||
|
||
## Шкала severity
|
||
|
||
| Severity | Что это | Пример |
|
||
|---|---|---|
|
||
| `critical` | нарушение инварианта проекта, потеря или порча данных, утечка секрета, построенный путь к отказу | запись потеряна при слиянии; тело пользовательской выгрузки в поле лога |
|
||
| `major` | сломанное требование дельта-спеки, необрабатываемый отказ штатного сценария, флаки-тест, поведение вне спеки, меняющее исход | приём отвечает 200, не записав тело: доставка считается принятой, а данных нет |
|
||
| `minor` | отступление от конвенции с реальной ценой, отсутствующая наблюдаемость, дублирование, которое разойдётся | ни одного чекпоинта на пути разбора: молчащая автоматизация неотличима от пустого потока |
|
||
| `nit` | нарушение записанной конвенции без последствий за пределами чтения | `msg` с интерполяцией вместо константы |
|
||
|
||
Шкала привязана к обратимости, а не к громкости: класс «необратимо и молча»
|
||
всегда весит больше класса «шумно и лечится повтором». Что здесь необратимо,
|
||
говорит `CLAUDE.md` — что в этом проекте необратимо.
|
||
|
||
## Блок границ покрытия
|
||
|
||
Каждый проход завершает вывод этим блоком. Он не сокращается и не заменяется
|
||
фразой «всё проверено».
|
||
|
||
```
|
||
## Coverage of this pass
|
||
- проверено: <что реально прочитано/запущено, с путями и командами>
|
||
- не проверялось и почему: <бюджет, недоступный инструмент, вне входа>
|
||
- принципиально недоступно этому проходу: <из charter'а агента>
|
||
```
|
||
|
||
## Финальный отчёт триажа
|
||
|
||
Секции строго в этом порядке, потолок — 7 пунктов в первых двух:
|
||
|
||
1. `Блокирует мердж` (≤3, каждая с оракулом);
|
||
2. `Стоит исправить сейчас` (≤4);
|
||
3. `Гипотезы без доказательства` — что понижено и почему;
|
||
4. `Promote candidates` — кандидаты в конвенцию или правило линтера;
|
||
5. `Границы покрытия` — сводная, обязательная.
|
||
|
||
Перед секциями — сводка для человека: размер, сложность, метка и режим
|
||
прогона, состояние гейта, **план разметки задачи с исходом по каждой теме**,
|
||
сколько находок пришло на вход и сколько осталось.
|
||
|
||
**Реестр сводки — темы, а не проходы, и это не оформление.** Перечень запущенных
|
||
проходов отвечает «все, кто должен был, отработали» и молчит о том, что именно
|
||
осталось непроверенным: уехавший в старшую метку проход уносит тему с собой
|
||
беззвучно. План же называет тему, её дом, глубину и исполнителя — и тема,
|
||
оставшаяся без отчёта, видна сразу. Перечень проходов из сводки не исчезает, но
|
||
идёт **внутри** плана, колонкой «кто закрывает».
|
||
|
||
Каждая находка в секциях 1–2 несёт дополнительное поле:
|
||
|
||
```
|
||
- Действие: инлайн | развилка
|
||
```
|
||
|
||
`инлайн` — оркестратор чинит сам, не спрашивая и не логируя. `развилка` — цена
|
||
исправления сопоставима с переработкой, либо выбор меняет scope, либо решение
|
||
трогает инвариант: уезжает вопросом с вариантами и ценой каждого туда, где
|
||
проект держит вопросы, а работа продолжается на остатке.
|
||
|
||
Потребитель отчёта — оркестратор, который **реализует прочитанное**. Поэтому
|
||
потолок в 7 пунктов — не забота о внимании читателя, а защита кодовой базы от
|
||
правок, которых никто не заказывал.
|