Посилання на номер випуску на GitHub у повідомленні про комісію


Відповіді:


952

Просто включіть #xxxу своє повідомлення про посилання, щоб посилатися на проблему, не закриваючи її.

З новими випусками GitHub 2.0 ви можете використовувати ці синоніми для посилання на проблему та закрити її (у своєму повідомленні про виконання):

  • fix #xxx
  • fixes #xxx
  • fixed #xxx
  • close #xxx
  • closes #xxx
  • closed #xxx
  • resolve #xxx
  • resolves #xxx
  • resolved #xxx

Ви також можете замінити #xxxна gh-xxx.

Виправлення посилань і закриття питань для репостів також працює:

fixes user/repo#xxx

Перегляньте документацію, наявну в розділі довідки.


4
Fix issue #xxxне працює для мене, якісь ідеї? Він посилається на проблему, але не закриває її.
Денніс

16
@Dennis видалити слово "питання"

1
@JamesTomasino, що можливо - я помітив, що це не працює для мене, коли я працюю у відділенні під назвою dev.
Джон Кернс

1
У яких ситуаціях кожен повинен використовуватись?
nilsi

1
Я не збираюся бути людиною, яка рухає цю відповідь від 666 голосів до 667, але це було ДУЖЕ корисно.
jakeatwork

168

Якщо ви хочете зв’язатись із проблемою GitHub і закрити її, ви можете вказати наступні рядки у своєму повідомленні про прихильність Git:

Closes #1.
Closes GH-1.
Closes gh-1.

(Будь-яка з трьох працює). Зауважте, що це посилання на проблему, а також закрити її. Ви можете дізнатися більше в цій публікації в блозі (почніть переглядати вбудоване відео близько 1:40).

Я не впевнений, чи подібний синтаксис буде просто посилатися на проблему, не закриваючи її.


31
Ви можете просто скористатись номером випуску (наприклад, № 456), яке буде посилатися на завдання, не закриваючи його.
Матьє Наполі

9
Я вибрав би "gh-1" over "# 1" просто тому, що ніколи не знаєш, чи сховище експортується / дзеркально кудись, крім github. Тоді "№1" не матиме великого сенсу.
хуйз

2
@mipadi: чи потрібне .після "закриття GH-1"? Це також
залежно від

1
@Lekensteyn: Я не вважаю, що період необхідний. Не впевнений у чутливості до регістру.
mipadi

message (closes GH-28)працює для мене, не впевнений, чи все не залежно від регістру.
Лекенштейн

64

Ви також можете перехрестити посилання репортажу:

githubuser/repository#xxx

xxx - номер випуску


62

github додає посилання на комітет, якщо він містить #issuenbr (виявив це випадково).


4
щойно перевірив це, працює як шарм, дякую ... це той, який слід позначити як правильну відповідь ...
відкривається

14

їм приємно написати про нові випуски 2.0 у своєму блозі https://github.blog/2011-04-09-isissue-2-0-the-next-generation/

синоніми включають

  • виправлення #xxx
  • виправлено #xxx
  • виправити #xxx
  • закривається #xxx
  • закрити #xxx
  • закрито #xxx

використання будь-якого з ключових слів у повідомленні про зобов’язання змусить вас згадати або закрити проблему.


Це вже було в моєму списку, я не думаю, що вони враховують регістри.
xero

4

Так само, як доповнення до інших відповідей: Якщо ви навіть не хочете писати повідомлення про фіксацію з номером проблеми , а випадково використовуєте Eclipse для розробки, тоді ви можете встановити плагіни eGit та Mylyn, а також роз'єм GitHub для Mylyn. Затем Eclipse може автоматично відстежувати, над якою проблемою ви працюєте, і автоматично заповнювати повідомлення про фіксацію , включаючи номер питання, як показано у всіх інших відповідях.

Докладніше про налаштування див. На веб-сторінці http://wiki.eclipse.org/EGit/GitHub/UserGuide


4

Для того, щоб зв’язати номер проблеми з вашим повідомленням про фіксацію, слід додати: #issue_numberу своєму повідомленні про виконання git.

Приклад повідомлення про фіксацію з Посібника зі стилю повідомлення Udacity Git Commit

feat: Summarize changes in around 50 characters or less

More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of the commit and the rest of the text as the body. The
blank line separating the summary from the body is critical (unless
you omit the body entirely); various tools like `log`, `shortlog`
and `rebase` can get confused if you run the two together.

Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequenses of this
change? Here's the place to explain them.

Further paragraphs come after blank lines.

 - Bullet points are okay, too

 - Typically a hyphen or asterisk is used for the bullet, preceded
   by a single space, with blank lines in between, but conventions
   vary here

If you use an issue tracker, put references to them at the bottom,
like this:

Resolves: #123
See also: #456, #789

Ви також можете посилатися на сховища:

githubuser/repository#issue_number

Немає сенсу (і насправді мене дратує), що вони використовують "подвиг" як абревіатуру для "функції", особливо коли в той же час вони використовують "рефактор", який навіть довший, ніж "функція".
Мішель Юнг

@MichelJung Ви можете стверджувати, що featвикористовується частіше refactor, а також немає очевидного абревіатури для refactor( refможе означати посилання, rfзанадто незрозуміло тощо).
Кріс Крашевський

3

Один з моїх перших проектів як програміста - це дорогоцінний камінь під назвою stagecoach, який (між іншим) дозволяв автоматично додавати номер випуску github до кожного повідомлення про комісію на гілці, що є частиною запитання, на яке насправді не відповіли. .

По суті, створюючи гілку, ви використовуєте власну команду (щось на зразок stagecoach -b <branch_name> -g <issue_number>), а номер випуску буде присвоєно цій гілці у файлі yml. Потім з’явився гак для здійснення, який автоматично додав номер проблеми до повідомлення про фіксацію.

Я б не рекомендував це для використання у виробництві, оскільки в той час я програмував лише кілька місяців і більше не підтримую, але це може зацікавити когось.


Я думаю, що ваша відповідь намагається вирішити точне запитання від ОП, тобто "спосіб автоматично мати посилання на питання, додане в комітеті". Усі інші відповіді покладаються на те, що програміст пам’ятає додати «Виправлення # ..., вирішено # ... тощо». словосполучення до комітету, і це не відбуватиметься кожного разу, як ми це знаємо. Оголошення.
demisx
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.