diff --git a/editorial/agent-rewrites/291.json b/editorial/agent-rewrites/291.json index 26be990..03f272f 100644 --- a/editorial/agent-rewrites/291.json +++ b/editorial/agent-rewrites/291.json @@ -1,7 +1,7 @@ { "index": 291, "slug": "editorial-2019-12-practice-code-ownership", - "title": "Код не равен решению: как назначить владельцев на стыке модулей", - "excerpt": "Ошибка проходит через несколько модулей, а команда ищет ответственного по последнему коммиту. Разделяем владельца решения, путь кода, review и проверку после merge.", - "contentHtml": "
Ошибка появляется на стыке checkout и платежного gateway. В журнале виден неизвестный статус, а экран показывает успешную оплату. Один разработчик ищет строку в parser, другой открывает последний коммит, третий ждёт ответа команды интеграции. Исправление задерживается, а следующий дефект повторяет ту же ошибку в соседнем файле. Цена — неверное состояние для пользователя, ручное расследование и потерянное время нескольких команд.
\nПоследний автор строки не обязан быть владельцем решения. Он мог перенести код, исправить форматирование или добавить временный обход. История Git отвечает на вопрос «кто менял строку». Она не отвечает на вопрос «что должен означать новый статус». Владелец пути отвечает за место изменения. Владелец решения отвечает за смысл контракта. Reviewer проверяет заданный риск. После merge отдельный человек проверяет результат.
\nСлово «владелец» слишком грубое для дефекта, который пересекает границы. Назначьте четыре роли. Владелец решения подтверждает допустимое поведение. Владелец пути кода знает реализацию и соседние переходы. Reviewer отвечает на конкретный вопрос в pull request. Владелец последующего действия проверяет сигнал после merge. Один человек может взять все роли. Но карточка должна показывать их отдельно.
\nНачинайте с наблюдаемого симптома. Запишите вход, неверный результат и место, где его видно. Формулировка «сломался checkout» не помогает. Формулировка «gateway вернул unknown, а обработчик перевёл его в success» задаёт границу расследования. В ней есть поведение, которое нужно подтвердить или отвергнуть.
git blame показывает revision и автора последнего изменения строки. Используйте его, чтобы найти контекст. Затем откройте git log --follow для пути и связанные документы. Не переносите найденное имя в поле владельца решения автоматически. Исторический факт полезен, но он не заменяет договорённость о статусах.
CODEOWNERS решает другую задачу. В GitHub файл сопоставляет пути с пользователями или командами и может автоматически запросить review. Правило берут из base branch pull request. Поэтому новая строка в feature branch ещё не доказывает, что маршрут сработает. Более узкое совпадение должно стоять после общего. Учебные имена ниже вымышлены и не относятся к рабочему репозиторию.
# .github/CODEOWNERS\n* @example/platform-review\n/web/checkout/ @example/checkout\n/web/checkout/gateway/ @example/payments\n/docs/checkout-contract.md @example/payments @example/checkout\n/.github/CODEOWNERS @example/repository-admins\nВ этом примере изменение gateway направляется команде платежей, а изменение контракта — двум областям. Последняя строка защищает сам маршрут. В реальном репозитории замените псевдонимы доступными пользователями или командами. Если у команды нет прав на репозиторий, автоматический запрос не создаёт знания и не исправляет процесс.
\n| Симптом | Причина | Проверка | Действие |
|---|---|---|---|
| Последний автор не отвечает | Исторический автор принят за владельца решения | Сравнить blame с diff, контрактом и тестами | Назначить decision owner по смыслу статуса |
| Review не пришёл | Путь не совпал или CODEOWNERS взят не из base branch | Проверить расположение, регистр, права и правило | Исправить маршрут или запросить reviewer вручную |
| PR approved, но риск остался | Одобрение не содержит проверяемого вопроса | Найти ответ на контракт и отрицательный путь | Перезапросить review с двумя конкретными вопросами |
| После merge нет результата | Follow-up не назначен | Проверить задачу, сигнал и срок проверки | Создать отдельное действие с исходом |
Ниже — учебный сценарий. Он не описывает production-инцидент и не утверждает, что кто-то видел такие метрики. Пусть gateway возвращает unknown. Обработчик должен сохранить это состояние и показать безопасный экран, а не считать значение успешным.
function mapGatewayStatus(status) {\n if (status === 'paid') return { state: 'success' };\n if (status === 'pending') return { state: 'pending' };\n return { state: 'unknown', diagnostic: 'gateway-status-unmapped' };\n}\n\nconst result = mapGatewayStatus('unknown');\n// result.state === 'unknown'; success недопустим\nВладелец решения подтверждает смысл unknown: это не оплата и не отказ, а состояние, которое требует безопасного отображения и диагностического следа. Владелец пути проверяет обработчик, retry и соседний экран. Reviewer задаёт два вопроса: не попадает ли неизвестное значение в success и сохраняется ли идентификатор для расследования. Follow-up owner проверяет запланированный сигнал после merge.
Если contract owner не найден, патч нельзя считать готовым. Исправление может выглядеть разумно, но команда всё ещё не знает, какое поведение считать правильным. Отрицательный путь здесь важнее красивой ветки успеха: тест должен явно отвергать unknown → success.
git blame -L, git log --follow и просмотр связанных контрактов. Отделите факт изменения от гипотезы о владении.CODEOWNERS на base branch. Убедитесь, что путь совпадает, регистр верен, а users и teams имеют нужные права.CODEOWNERS не является каталогом экспертизы. Он знает путь и правила платформы. Он не подтверждает бизнес-смысл изменения и не проверяет production. Не делайте правило * единственной картой знания: оно направит запрос, но не покажет, кто решает спорный контракт.
GitHub — только один вариант реализации. В другой системе может не быть CODEOWNERS или автоматического запроса. Тогда сохраните ту же модель в issue или шаблоне pull request: decision owner, code path owner, reviewer, follow-up owner. Меняется инструмент, но не вопросы, на которые должен ответить change.
\nНе превращайте карту владения в процесс ради процесса. Для маленького модуля достаточно четырёх полей, одного теста и двух конкретных вопросов. Обновляйте маршрут, когда каталог переезжает или команда меняет границу. Устаревший список создаёт ложное чувство контроля.
\nРабота готова, если независимый разработчик может открыть задачу и найти четыре ответа: кто подтвердил смысл решения, где лежит изменённый путь, кто проверил риск и кто проверит результат после merge. Тест не допускает превращения unknown в success. Review содержит ответ на контрактный вопрос. Маршрут ownership проверен в base branch. После merge есть записанный сигнал или отдельная задача с назначенным исполнителем.
Если хотя бы одного ответа нет, закрывайте кодовый change только как промежуточный результат. Это честнее, чем назвать исправление завершённым по одному факту merge.
\nОшибка появляется на стыке checkout и платёжного gateway. В журнале виден неизвестный статус, а экран показывает успешную оплату. Один разработчик ищет строку в parser, другой открывает последний коммит, третий ждёт ответа команды интеграции. Исправление задерживается, а следующий дефект повторяет ту же ошибку в соседнем файле. Цена — неверное состояние для пользователя, ручное расследование и потерянное время нескольких команд.
\nВ такой ситуации полезно сначала назначить не человека, а вопросы. Какой результат разрешён контрактом? Где проходит путь изменения? Кто проверит риск в pull request? Кто посмотрит на результат после merge? Если на все вопросы ответить «последний автор строки», команда подменяет исторический факт решением о текущей ответственности.
\nПоследний автор строки не обязан быть владельцем решения. Он мог перенести код, исправить форматирование или добавить временный обход. История Git отвечает на вопрос «кто менял строку». Она не отвечает на вопрос «что должен означать новый статус». Владелец пути знает реализацию и соседние переходы. Владелец решения подтверждает смысл контракта. Reviewer проверяет заданный риск. После merge отдельный исполнитель проверяет наблюдаемый результат.
\nОдин человек может взять все роли. Но в задаче их стоит записать отдельно. Это уменьшает число скрытых предположений: если решение не принято, его нельзя выдать за результат ревью. Если путь не найден, согласование контракта не означает, что код изменён. Если follow-up не назначен, merge не доказывает, что пользовательский симптом исчез.
\nНачните с входа, неверного результата и места наблюдения. Фраза «сломался checkout» слишком широка. Формулировка «gateway вернул unknown, а обработчик перевёл его в success» задаёт проверяемую границу. В ней есть значение, преобразование и пользовательский эффект.
Затем отделите факт от гипотезы. Фактом будет ответ gateway, строка преобразования, запись в журнале или результат теста. Гипотеза — что именно должен делать продукт с неизвестным значением. Её подтверждает владелец решения по контракту, а не автор строки и не число совпавших поисковых результатов.
\nВладелец решения подтверждает допустимые состояния и поведение на границе контракта. Для платежа он отвечает, означает ли unknown ожидание, ошибку, ручную проверку или отдельный безопасный экран.
Владелец пути кода находит parser, обработчик, экран, retry и тесты, которые действительно участвуют в переходе. Его задача — не решить бизнес-смысл, а показать, где изменение повлияет на поведение и какие соседние ветки нужно проверить.
\nReviewer получает конкретный риск. Вопрос «всё ли нормально?» плохо проверяем. Вопросы «может ли неизвестное значение попасть в success?» и «сохраняется ли диагностический идентификатор?» задают наблюдаемый результат ревью.
\nВладелец последующей проверки смотрит на результат после merge. Это может быть тестовый сценарий, журнал, метрика или ручная проверка экрана. Такая роль не подтверждает заранее, что изменение сработает: она фиксирует, что именно проверено и с каким исходом.
\n| Симптом | Вопрос | Доказательство | Действие |
|---|---|---|---|
| Последний автор не отвечает | Кто подтверждает смысл статуса? | Контракт, решение владельца, отрицательный тест | Назначить владельца решения |
| Review не пришёл | Какой путь и какое правило совпали? | Путь файла, версия CODEOWNERS из base branch, права | Исправить маршрут или запросить reviewer вручную |
| PR одобрен, но риск не назван | Что именно проверил reviewer? | Ответ на контрактный вопрос и проверка отрицательной ветки | Уточнить review до merge |
| После merge нет результата | Кто и где проверит симптом? | Runbook, тест, журнал или отдельная задача с исходом | Назначить follow-up и срок проверки |
git blame показывает revision и автора, который последним изменил строку. Используйте его, чтобы найти контекст изменения, а не чтобы автоматически назначить владельца. Затем git log --follow -- path/to/file может продолжить историю одного файла за переименованием. Опция относится к одному файлу; она не просматривает автоматически всю папку и не заменяет чтение контракта.
git blame -L 42,58 -- src/checkout/gateway-status.js\ngit log --follow -- src/checkout/gateway-status.js\ngit show <revision> -- src/checkout/gateway-status.js\nЭта последовательность даёт три разных факта: кто менял диапазон, какие коммиты относятся к пути и что именно изменилось в найденной revision. После неё всё равно нужно проверить потребителей статуса и тесты. История помогает восстановить контекст, но не служит каталогом актуальной экспертизы.
\nCODEOWNERS — механизм GitHub для назначения пользователей или команд, ответственных за пути. GitHub может автоматически запросить review у владельцев, если pull request меняет принадлежащий им файл. Для маршрутизации используется файл из base branch pull request, поэтому новая запись только в feature branch ещё не доказывает, что запрос сработает.
Порядок правил важен: для одного пути приоритет получает последнее совпавшее правило. Поэтому общее правило обычно ставят выше частного, а частное — ниже; проверять нужно именно фактическое совпадение, регистр пути и доступ владельца. Пользователь или команда должны иметь права записи в репозитории. Само совпадение пути не подтверждает бизнес-смысл решения и не гарантирует, что reviewer ответит на нужный вопрос.
\n# .github/CODEOWNERS\n* @example/platform-review\n/web/checkout/ @example/checkout\n/web/checkout/gateway/ @example/payments\n/docs/checkout-contract.md @example/payments @example/checkout\n/.github/CODEOWNERS @example/repository-admins\nИмена в примере вымышлены. Для файла /web/checkout/gateway/status.js последним совпадёт правило /web/checkout/gateway/, поэтому оно перекроет более раннее общее правило. Для документа контракта сработает отдельная строка и назначит двух владельцев на одной строке. В рабочем репозитории замените псевдонимы существующими пользователями или командами и проверьте их права.
Ниже — учебный сценарий, а не описание production-инцидента. Правило unknown в нём проектное: неизвестный ответ не считается ни успешной оплатой, ни отказом. В реальном продукте это решение должен подтвердить владелец контракта.
function mapGatewayStatus(status) {\n if (status === 'paid') return { state: 'success' };\n if (status === 'pending') return { state: 'pending' };\n return { state: 'unknown', diagnostic: 'gateway-status-unmapped' };\n}\n\nconst cases = ['paid', 'pending', 'unknown'];\nconst results = cases.map((status) => ({\n status,\n result: mapGatewayStatus(status),\n}));\n\nconsole.table(results);\n// unknown: state = 'unknown', success недопустим\nПроверка воспроизводима: запустите фрагмент в Node.js или браузерной консоли и убедитесь, что три входа дают три ожидаемых результата. Затем добавьте тест, который явно отвергает unknown → success. Это не доказывает правильность всего checkout, но фиксирует одну границу, о которой reviewer может задать точный вопрос.
Владелец решения подтверждает смысл unknown. Владелец пути проверяет обработчик, retry, экран и потребителей поля diagnostic. Reviewer проверяет, что неизвестное значение не попадает в success и что диагностический след не теряется. Владелец последующей проверки смотрит на выбранный сигнал после merge. Если решение по контракту не найдено, кодовый change нельзя считать завершённым только потому, что пример выглядит разумно.
git blame, git log --follow и просмотр diff. Помните, что история одного файла не описывает всех потребителей.CODEOWNERS знает путь и правила конкретной платформы. Он не служит каталогом экспертизы, не подтверждает бизнес-смысл и не проверяет production. Требование обязательного одобрения владельца появляется только при соответствующей настройке защиты ветки или ruleset. Если маршрут не настроен, ручной запрос reviewer всё равно не заменяет решение владельца.
GitHub — только один вариант реализации. В другой системе может не быть CODEOWNERS или автоматического запроса. Сохраните ту же модель в issue или шаблоне pull request: владелец решения, владелец пути, reviewer и последующая проверка. Меняется инструмент, но не вопросы, на которые должен ответить change.
\nНе превращайте карту владения в процесс ради процесса. Для небольшого модуля достаточно четырёх полей, одного отрицательного теста и двух конкретных вопросов. Обновляйте маршрут, когда каталог переезжает, путь меняет регистр или команда меняет границу. Устаревший список создаёт ложное чувство контроля.
\nИзменение готово, если независимый разработчик может открыть задачу и найти четыре ответа: кто подтвердил смысл решения, где лежит изменённый путь, кто проверил риск и кто проверит результат после merge. Тест не допускает превращения unknown в success. Review содержит ответ на контрактный вопрос. Маршрут ownership проверен в base branch. После merge есть записанный сигнал или отдельная задача с назначенным исполнителем.
Если хотя бы одного ответа нет, закрывайте кодовый change только как промежуточный результат. Это честнее, чем назвать исправление завершённым по одному факту merge.
\n--follow и просмотр истории одного файла за переименованием.