GitHub розпізнає ключові слова в описі pull request (і в повідомленнях комітів) і пов'язує PR із задачею:
Closes #412
Fixes #418, resolves #420
Fixes acme/api#77
Ключові слова: close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved. Регістр не важливий, двокрапка після слова допускається.
Що відбувається:
- задача показує, що над нею працюють, і містить посилання на PR;
- після злиття PR задача закривається автоматично;
- можна вказати задачу з іншого репозиторію:
owner/repo#номер.
Важливий нюанс: ключові слова працюють, лише якщо PR спрямовано в гілку за замовчуванням (зазвичай main). PR у develop чи релізну гілку з Closes #412 не створить зв'язку й не закриє задачу. Для таких випадків зв'язок створюють вручну на бічній панелі PR (розділ Development).
Згадка без закриття: просто #412 чи «див. #412» створює перехресне посилання, але задачу не закриває. Це доречно, коли PR лише частина роботи:
Частина #412: міграція й модель. Інтерфейс - окремим PR.
Практичні поради:
- одна задача - одна причина PR: якщо PR закриває п'ять задач, це, мабуть, кілька різних змін;
- для задач з трекера поза GitHub (Jira, Linear) - номер задачі в назві гілки чи заголовку (
ABC-123), а інтеграція трекера підхопить зв'язок; - автопосилання (Settings → Autolink references) перетворюють
ABC-123у тексті на посилання на зовнішній трекер.
Докладніше в документації: GitHub: зв'язок pull request із задачею