av
7998c6b86e
- умолчание — делать, а не спрашивать: развилка вынимается пунктом в секцию `блокеры` беклога, задача переформулируется на остаток и доводится до коммита - спрашиваем только про необратимое: деплой, выкладку наружу, удаление данных - находка ревью с пометкой «развилка» больше не останавливает работу, а уезжает блокером с вариантами и ценой каждого
86 lines
6.7 KiB
Markdown
86 lines
6.7 KiB
Markdown
# Контракт находок
|
||
|
||
Единый формат для всех проходов конвейера ревью. Проход, нарушивший контракт,
|
||
считается сломанным — триаж вправе выбросить его вывод целиком.
|
||
|
||
## Форма находки
|
||
|
||
```
|
||
### <краткая формулировка ПОСЛЕДСТВИЯ, не симптома>
|
||
- Файл: internal/store/bucket.go:120-134
|
||
- Severity: critical | major | minor | nit
|
||
- Confidence: high | medium | low
|
||
- Оракул: <падающий тест / команда с выводом / положение гайда / нет>
|
||
- Последствие: <что произойдёт и при каких условиях>
|
||
- Предложение: <конкретное изменение>
|
||
- Найдено проходом: <имя агента>
|
||
```
|
||
|
||
## Правила
|
||
|
||
- **Заголовок через последствие.** Не «нет проверки токена», а «читатель без
|
||
токена выгрузит всю историю пульса». Не «слияние перезаписывает точку», а
|
||
«повторная доставка сотрёт `start`/`end` у уже сохранённой точки, и восстановить
|
||
их можно только из экспорта Apple». Симптом в
|
||
заголовке — это заявка на то, что читатель сам достроит последствие; он не
|
||
достроит, он просто починит симптом.
|
||
- **`critical` без оракула или построенного пути не существует.** Оракул — это
|
||
падающий тест, вывод выполненной команды или поимённое положение гайда. Не
|
||
«вероятно, здесь гонка», а `CGO_ENABLED=1 go test -race` с выводом детектора.
|
||
- **`confidence: low` — это «так обычно пишут».** Такие находки допустимы, но не
|
||
поднимаются выше `minor`. Частотность конструкции в публичном Go — не аргумент.
|
||
- **Находка без поля «Последствие» не выводится вовсе.** Пустое «Последствие:
|
||
ухудшает читаемость» равносильно отсутствию поля.
|
||
- **`nit` допустим только при нарушении записанной конвенции** — со ссылкой на
|
||
файл и раздел `docs/conventions.md` либо на правило `.golangci.yml`. Если
|
||
правило механизируемо, но не механизировано — это не находка ревью, это
|
||
`Promote candidate` (см. [promote.md](promote.md)).
|
||
- **Расхождение — не дефект, пока не названо последствие.** Особенно для
|
||
`healthlog-review-reimpl`: «я бы сделал иначе» без последствия не выводится.
|
||
|
||
## Шкала severity
|
||
|
||
| Severity | Что это | Пример |
|
||
|---|---|---|
|
||
| `critical` | нарушение инварианта безопасности данных, потеря/порча данных, утечка секрета, построенный путь к отказу | точка потеряна при слиянии часового объекта, тело выгрузки Apple Health в поле лога |
|
||
| `major` | сломанное требование дельта-спеки, необрабатываемый отказ штатного сценария, флаки-тест, поведение вне спеки, меняющее исход | приём отвечает 200, не записав тело в архив: доставка считается принятой, а данных нет |
|
||
| `minor` | отступление от конвенции с реальной ценой, отсутствующая наблюдаемость, дублирование, которое разойдётся | разбор пакета не пишет ни одного чекпоинта, и молчащая автоматизация неотличима от пустого потока |
|
||
| `nit` | нарушение записанной конвенции без последствий за пределами чтения | `msg` с интерполяцией вместо константы |
|
||
|
||
## Блок границ покрытия
|
||
|
||
Каждый проход завершает вывод этим блоком. Он не сокращается и не заменяется
|
||
фразой «всё проверено».
|
||
|
||
```
|
||
## Coverage of this pass
|
||
- проверено: <что реально прочитано/запущено, с путями и командами>
|
||
- не проверялось и почему: <бюджет, недоступный инструмент, вне входа>
|
||
- принципиально недоступно этому проходу: <из charter'а агента>
|
||
```
|
||
|
||
## Финальный отчёт триажа
|
||
|
||
Секции строго в этом порядке, потолок — 7 пунктов в первых двух:
|
||
|
||
1. `Блокирует мердж` (≤3, каждая с оракулом);
|
||
2. `Стоит исправить сейчас` (≤4);
|
||
3. `Гипотезы без доказательства` — что понижено и почему;
|
||
4. `Promote candidates` — кандидаты в конвенцию или правило линтера;
|
||
5. `Границы покрытия` — сводная, обязательная.
|
||
|
||
Каждая находка в секциях 1–2 несёт дополнительное поле:
|
||
|
||
```
|
||
- Действие: инлайн | развилка
|
||
```
|
||
|
||
`инлайн` — оркестратор чинит сам, не спрашивая и не логируя. `развилка` — цена
|
||
исправления сопоставима с переработкой, либо выбор меняет scope, либо решение
|
||
трогает инвариант: уезжает блокером в беклог вопросом с вариантами и ценой
|
||
каждого, а работа продолжается на остатке.
|
||
|
||
Потребитель отчёта — оркестратор, который **реализует прочитанное**. Поэтому
|
||
потолок в 7 пунктов — не забота о внимании читателя, а защита кодовой базы от
|
||
правок, которых никто не заказывал.
|