РуководствоGuideПосібник

Справиться с мелкими правками, багами и побочными находками без церемонийHandle small edits, bugs and side findings without ceremonyУпоратися з дрібними правками, багами й побічними знахідками без церемоній

Большинство правок мелкие, и для них в kit есть дешёвый путь. Путь выбирают по тому, чего касается правка, а не по тому, насколько она кажется важной: одна строка, узкий баг с понятной причиной или что-то с проектными решениями. То, что вы замечаете по дороге, откладывается, а не преследуется. Затем вы запускаете результат, отдаёте его на ревью, добиваетесь, чтобы все места, где его видит пользователь, говорили одно и то же, и раскладываете его по коммитам.Most edits are small, and the kit has a cheap path for them. You choose the path by what the change touches, not by how important it feels: one line, a narrow bug with a known cause, or something with design decisions. What you notice on the way is parked instead of chased. Then you run the result, have it reviewed, make every place a user sees it agree, and sort it into commits.Більшість правок дрібні, і для них у kit є дешевий шлях. Шлях обирають за тим, чого торкається правка, а не за тим, наскільки вона здається важливою: один рядок, вузький баг зі зрозумілою причиною або щось із проєктними рішеннями. Те, що ви помічаєте дорогою, відкладається, а не переслідується. Потім ви запускаєте результат, віддаєте його на рев'ю, домагаєтеся, щоб усі місця, де його бачить користувач, казали те саме, і розкладаєте його по комітах.

Функции в этом руководствеFunctions in this guideФункції в цьому посібнику

ШагиStepsКроки

  1. Выберите путь по тому, чего касается правка. Для одного токена, строки, подписи, цвета или локального переименования подходит /quick: /quick fix typo in the Save button label. Он вносит правку, запускает самую маленькую подходящую проверку и отчитывается одним предложением. Он отказывается от бизнес-логики, поведения для пользователя, нового класса, функции или модуля, схемы, зависимостей и конфигурации сборки, а также от всего, что больше 3 файлов или примерно 50 строк.Choose the path by what the change touches. For one token, string, label, colour or a local rename, use /quick: /quick fix typo in the Save button label. It makes the edit, runs the smallest check that fits and reports in one sentence. It refuses business logic, user-facing behaviour, a new class, function or module, a schema, dependency or build config, and anything over 3 files or about 50 lines.Оберіть шлях за тим, чого торкається правка. Для одного токена, рядка, підпису, кольору чи локального перейменування годиться /quick: /quick fix typo in the Save button label. Він вносить правку, запускає найменшу відповідну перевірку й звітує одним реченням. Він відмовляється від бізнес-логіки, поведінки для користувача, нового класу, функції чи модуля, схеми, залежностей і конфігурації збірки, а також від усього, що більше за 3 файли чи приблизно 50 рядків.
  2. Для бага с понятной причиной, который больше однострочной правки, берите /fix: /fix retry loop never backs off, hammers the server on 503. Он называет первопричину до того, как тронет код, вносит самую маленькую правку, которая её устраняет, проверяет результат локально и отчитывается тремя строками: причина, правка, проверка. Если причина всё ещё неясна, сначала нужен /research.For a bug with an understood cause that is bigger than a one-line edit, use /fix: /fix retry loop never backs off, hammers the server on 503. It names the root cause before it touches code, makes the smallest change that removes it, checks the result locally and reports cause, fix and validation in three lines. If the cause is still unclear, /research comes first.Для багу зі зрозумілою причиною, що більший за однорядкову правку, беріть /fix: /fix retry loop never backs off, hammers the server on 503. Він називає першопричину, перш ніж торкнеться коду, вносить найменшу правку, що її усуває, перевіряє результат локально й звітує трьома рядками: причина, правка, перевірка. Якщо причина досі неясна, спершу потрібен /research.
  3. Знайте, где кончается дешёвый путь. Решение о дизайне или UX идёт в /ui-clarify, затем в /spec; новая абстракция, схема или миграция, публичный API - в /spec. Когда команда упирается в эту границу, она так и говорит: /quick одной строкой называет причину и подходящую команду и ничего не меняет, а /fix останавливается посреди работы и передаёт задачу дальше, если список файлов вырос больше чем до нескольких. Принимайте перенаправление, а не проталкивайте правку силой.Know where the cheap path ends. A design or UX decision goes to /ui-clarify and then /spec; a new abstraction, a schema or migration, or a public API goes to /spec. When a command meets that edge it says so: /quick answers in one line with the reason and the command that fits and changes nothing, and /fix stops midway and escalates if its file list outgrows a handful of files. Take the redirect instead of pushing the edit through.Знайте, де закінчується дешевий шлях. Рішення про дизайн чи UX іде до /ui-clarify, потім до /spec; нова абстракція, схема або міграція, публічний API - до /spec. Коли команда впирається в цю межу, вона так і каже: /quick одним рядком називає причину й відповідну команду та нічого не змінює, а /fix зупиняється посеред роботи й передає задачу далі, якщо список файлів виріс більше ніж до кількох. Приймайте перенаправлення, а не проштовхуйте правку силоміць.
  4. Когда по дороге нашлась настоящая проблема вне задачи, которой нужно отдельное расследование, отложите её: /park retry loop in sync_client never backs off - found while auditing the cache layer. Команда записывает минимальную заготовку тикета со статусом Draft, приоритетом по умолчанию, симптомом в одну строку и местом находки, ничего не расследует и возвращает вас к задаче. Тривиальную строку вне задачи правьте на месте, косметическую придирку отбросьте, находку в рамках задачи считайте работой. Заготовка - живой тикет: /backlog подберёт его, а /spec <ID> развернёт.When you find a real problem outside the task that needs its own investigation, park it: /park retry loop in sync_client never backs off - found while auditing the cache layer. It writes a minimal Draft ticket stub with a default priority, a one-line symptom and where you found it, investigates nothing and returns you to the task. Fix a trivial out-of-scope line inline, drop a cosmetic nitpick, and treat an in-scope finding as work. The stub is a live ticket: /backlog can pick it up and /spec <ID> can expand it.Коли дорогою знайшлася справжня проблема поза задачею, якій потрібне окреме розслідування, відкладіть її: /park retry loop in sync_client never backs off - found while auditing the cache layer. Команда записує мінімальну заготовку тікета зі статусом Draft, пріоритетом за замовчуванням, симптомом в один рядок і місцем знахідки, нічого не розслідує й повертає вас до задачі. Тривіальний рядок поза задачею правте на місці, косметичну прискіпливість відкиньте, знахідку в межах задачі вважайте роботою. Заготовка - живий тікет: /backlog потім підбере його, а /spec <ID> розгорне.
  5. Когда важно поведение, проверьте правку запуском. /prove запускает цель, проходит короткий сценарий, снимает вывод и заканчивает одной строкой ровно с одним вердиктом: PASS, DEFECT, COULD NOT VERIFY или NOT APPLICABLE. Прохождением считается только PASS. /prove без аргументов - дымовой прогон по умолчанию, с вашим текстом он берёт этот текст как сценарий, а --build сначала пересобирает. Файл сценария ложится в каталог scratch.Check the change by running it when behaviour matters. /prove starts the target, walks a short scenario, captures the output and ends in one line with exactly one verdict: PASS, DEFECT, COULD NOT VERIFY or NOT APPLICABLE. Only PASS is a pass. /prove alone is a default smoke run, /prove plus your own text takes that text as the scenario, and --build rebuilds first. The scenario file lands in the scratch directory.Коли важлива поведінка, перевірте правку запуском. /prove запускає ціль, проходить короткий сценарій, знімає вивід і закінчує одним рядком рівно з одним вердиктом: PASS, DEFECT, COULD NOT VERIFY або NOT APPLICABLE. Проходженням вважається лише PASS. /prove без аргументів - димовий прогін за замовчуванням, з вашим текстом він бере цей текст як сценарій, а --build спершу перезбирає. Файл сценарію лягає в каталог scratch.
  6. Отдайте дифф на ревью командой /critique: без аргументов она берёт текущий дифф, а область можно сузить, например /critique src/payments/. Она читает изменение и достаточно окружающего кода и выдаёт каждое замечание в виде severity · file:line · проблема · конкретная правка, от bug до q, а в конце называет единственное самое важное, что нужно решить до слияния. Замечания высокой серьёзности она сначала подтверждает или опровергает сама. Для одной короткой строки на замечание есть /caveman-review.Have the diff reviewed with /critique: bare, it takes the current diff, or scope it, for example /critique src/payments/. It reads the change and enough surrounding code and reports each finding as severity · file:line · the problem · a concrete fix, from bug down to q, then the single most important thing to address before merge. It confirms or refutes its own high-severity findings first. For one terse line per finding, use /caveman-review.Віддайте діф на рев'ю командою /critique: без аргументів вона бере поточний діф, а область можна звузити, наприклад /critique src/payments/. Вона читає зміну й достатньо навколишнього коду та видає кожне зауваження у вигляді severity · file:line · проблема · конкретна правка, від bug до q, а наприкінці називає єдине найважливіше, що треба розв'язати до злиття. Зауваження високої серйозності вона спершу підтверджує або спростовує сама. Для одного короткого рядка на зауваження є /caveman-review.
  7. Если изменение видит пользователь, закончите /surfaces: без аргументов для текущего диффа или с однострочным описанием. Команда печатает таблицу всех мест, где изменение видно (поверхностей): строки интерфейса по авторским локалям, справка, README и его переводы, документация, сайт, журнал изменений, карточки. Каждая строка либо затронута, либо не применима с причиной; затронутые правятся во всех авторских локалях, а по ним ищутся ключевое существительное и прежнее имя. Внутреннее изменение сразу заканчивается строкой surfaces: not user-visible - <reason>.If a user can see the change, finish with /surfaces: bare for the current diff, or with a one-line description. It prints a table of every place the change shows, each one a surface: UI strings per authored locale, help, the README and its translations, docs, the site, the change log, listings. Each row is touched or not applicable with a reason, touched rows are edited in every authored locale, and the key noun and any old name are grepped across them. An internal change ends at once with surfaces: not user-visible - <reason>.Якщо зміну бачить користувач, завершіть /surfaces: без аргументів для поточного діфа або з однорядковим описом. Команда друкує таблицю всіх місць, де зміну видно, кожне з них - поверхня: рядки інтерфейсу за авторськими локалями, довідка, README та його переклади, документація, сайт, журнал змін, картки. Кожен рядок або зачеплений, або незастосовний із причиною; зачеплені правляться в усіх авторських локалях, а по них шукаються ключовий іменник і попереднє ім'я. Внутрішня зміна одразу завершується рядком surfaces: not user-visible - <reason>.
  8. Разложите готовые изменения по коммитам с помощью /git: /git what should I commit now?. Он читает git status и активную ветку, группирует файлы по темам в 2-4 логичных коммита, называет файлы, которые коммитить нельзя (результат сборки, кэши, секреты, всё из scratch), и предлагает сообщения в формате Conventional Commit с точными командами git add. Пока вы не попросите, он не коммитит и не пушит.Sort the finished changes into commits with /git: /git what should I commit now?. It reads git status and the active branch, groups files by concern into 2 to 4 logical commits, names the files that must stay out, such as build output, caches, secrets and anything under scratch, and proposes Conventional Commit messages with the exact git add commands. It does not commit or push unless you ask.Розкладіть готові зміни по комітах за допомогою /git: /git what should I commit now?. Він читає git status та активну гілку, групує файли за темами у 2-4 логічні коміти, називає файли, які комітити не можна (результат збирання, кеші, секрети, усе зі scratch), і пропонує повідомлення у форматі Conventional Commit з точними командами git add. Доки ви не попросите, він не комітить і не пушить.
Что вы должны увидетьWhat you should seeЩо ви маєте побачити

Отчёт в одно предложение от /quick или в три строки от /fix, побочные находки записаны заготовками Draft, а не превратились в объезды, строка с вердиктом от /prove там, где важно поведение, отчёт /critique по серьёзности, отчёт /surfaces для видимого пользователю изменения и 2-4 группы коммитов с сообщениями и командами git add.A one-sentence report from /quick or a three-line report from /fix, side findings recorded as Draft stubs instead of detours, a verdict line from /prove where behaviour mattered, a /critique report by severity, a /surfaces report for a user-visible change, and 2 to 4 commit groups with messages and git add commands.Звіт в одне речення від /quick або в три рядки від /fix, побічні знахідки записані заготовками Draft, а не перетворилися на об'їзди, рядок із вердиктом від /prove там, де важлива поведінка, звіт /critique за серйозністю, звіт /surfaces для видимої користувачеві зміни і 2-4 групи комітів із повідомленнями та командами git add.

Термины на этой страницеTerms on this pageТерміни на цій сторінці

Поиск по порталуSearch the portalПошук по порталу