Словарь GitHub issues: reproduce, workaround, upstream, wontfix

Тема дорожной карты · Английский для IT

🔊 Словарь терминов с произношением →

Issue-трекер открытого проекта — место, где инженер ищет решение проблемы и где общается с мейнтейнерами, и у него есть свой словарь. Роли: maintainer — сопровождающий проект, contributor — участник, author / reporter / OP (original poster) — автор issue, triager — тот, кто разбирает входящие. Виды issue: bug report, feature request — запрос функциональности, question, discussion, RFC / proposal — предложение, tracking issue — зонтичная задача, отслеживающая связанные, meta issue, epic. Метки: bug, enhancement — улучшение, good first issue — подходит новичку, help wanted — нужна помощь, needs triage — ждёт разбора, needs repro / needs more info — нужны шаги воспроизведения, confirmed — подтверждено, duplicate — дубликат, wontfix — не будет исправлено (по решению), invalid — не является проблемой, stale — неактивно, будет закрыто ботом, blocked — заблокировано другим, upstream — проблема в зависимости выше по цепочке, regression, P0 … P3, breaking, security, documentation. Глаголы и фразы: to reproduce (I can repro on 2.4), minimal reproducible example (MRE, MCVE, repro) — минимальный пример, steps to reproduce, workaround — обход, root cause, to bisect — найти коммит-виновник, to file an issue — завести, to open / close / reopen, to link — связать, closes #123 — закрывается PR, fixed in #456 — исправлено в PR, landed in main — попало в основную ветку, released in 2.5.0, to upstream a fix — отправить исправление в исходный проект, downstream — проекты, зависящие от этого, to fork, to cherry-pick, PTAL, cc @user — упомянуть, bump — «поднять» неактивную issue напоминанием, +1 / me too — «у меня тоже» (мейнтейнеры просят вместо этого ставить реакцию 👍), subscribed — подписался, any updates? — есть новости? (считается невежливым, если задавать часто), ETA? — когда ждать?, out of scope — вне рамок проекта, by design — так задумано, works as intended, cannot reproduce, needs a test, LGTM, nice catch, thanks for the report, feel free to open a PR — вежливое «сделайте сами», PRs welcome — то же.

Как произносится

Issue /ˈɪʃuː/, maintainer /meɪnˈteɪnər/ (ударение на второй слог), contributor /kənˈtrɪbjʊtər/ (ударение на второй слог, «кэнтрИбьютер»), triage /ˈtriːɑːʒ/, enhancement /ɪnˈhɑːnsmənt/, reproduce /ˌriːprəˈdjuːs/, repro /ˈriːproʊ/, reproducible /ˌriːprəˈdjuːsəbl/, workaround /ˈwɜːrkəraʊnd/, upstream /ˈʌpstriːm/, downstream /ˈdaʊnstriːm/, wontfix «уонт-фикс», duplicate /ˈdjuːplɪkət/, stale /steɪl/, invalid /ɪnˈvælɪd/ (ударение на второй слог), bisect /ˈbaɪsɛkt/, proposal /prəˈpoʊzəl/, epic /ˈɛpɪk/, landed /ˈlændɪd/, intended /ɪnˈtɛndɪd/, scope /skoʊp/.

Как употребляется

Типичный тред:

  • Reporter: Getting ECONNRESET on every second request since 2.4.0. Repro: run the attached script with Node 22.
  • Maintainer: Thanks for the report. Can't repro on macOS; which OS? Also, does it happen on 2.3.x?
  • Reporter: Ubuntu 24.04. 2.3.9 works, so it's a regression. Bisected to commit a1b2c3.
  • Maintainer: Nice catch, that's the keep-alive change. Workaround for now: set keepAlive: false. Fix incoming.
  • Maintainer: Fixed in #789, landed in main, will be released in 2.4.1. Closing.
  • Another user: Any updates on the release? — Maintainer: 2.4.1 is out.

Фразы для запроса: Is there a workaround? — Есть обход? Is this tracked anywhere? — Это где-то отслеживается? Happy to open a PR if you point me to the right place. — Готов сделать PR, если подскажете, куда смотреть.

Ловушки

Первая ловушка — писать +1 или me too без информации: мейнтейнеры считают это шумом; полезны только новые детали или реакция. Вторая — any updates? через день после открытия: в open source ответ может занять недели. Третья — wontfix как грубость: это решение, обычно с объяснением; спорить уместно с аргументами, не с эмоциями. Четвёртая — upstream и downstream путать: upstream — проект, от которого зависите; downstream — те, кто зависит от вас. Пятая — maintainer с ударением на первый слог. Шестая — invalid как «инвалид»: /ɪnˈvælɪd/, «недействительный». Седьмая — issue без минимального примера: без repro её закроют с needs more info. Восьмая — писать issue по-русски в международном проекте: её не прочитают.

Связанные понятия

Полезные ресурсы