Вопрос — написание commit messages

fix xxx
fixed xxx
xxx was fixed
xxx has been fixed

народ, а как правильно то ?
т.е. раньше я писал в формате «fixed xxx» (changed xxx, added xxx, removed ...), потом вроде как немного разобрался с passive tense
и теперь хочется писать (да и пишу) «xxx has been fixed »
но погуглил — говорят что правильно «fix xxx» (add xxx) и таде

но оно вроде как неудобно далее в переписке — change log выглядит как-то ненатурально что-ли, или если кому-то отправлять список того, что сделано — так (с has been fixed) накопировал и отправил, а если вариант «fix» то вроде как надо исправлять на правильные времена

👍НравитсяПонравилось0
В избранноеВ избранном0
LinkedIn
Допустимые теги: blockquote, a, pre, code, ul, ol, li, b, i, del.
Ctrl + Enter
Допустимые теги: blockquote, a, pre, code, ul, ol, li, b, i, del.
Ctrl + Enter

Надо писать в императиве, как команду, которую «накатывает» коммит: починить багу, добавить фичу, т.е. fix, add, merge, etc.

Пишу презент, так как звучит тайтл задачи: имплемент ..., фикс ... и номер таска, потом идет пустая строка и тело сообщения, если требуется или такое есть в наличии илиесть, что расписать

Past tense. Например, Implemented xxxx, Fixed problem with xxxx, ...

Например, Implemented xxxx, Fixed problem with xxxx, ...
а то что это грамматически неграмотно, не напрягает ?

Неа. Мысленно подставляю в начало фразы: At this commit on 20xx-xx-xx I ... — и все хорошо.

ну так найдите (подразумеваемое) начало месседжа, ага?
тогда поймете

типа,
сим коммитом я... (что делаю?)

has been fixed
Поздравляю, так пишут оптимисты

Номер тикета + его название.
Иногда строкой ниже дописываю что конкретно сделано, это когда лень делать подзадачу )
Раньше вставляли ссылку на тикет, но после установки FishEye в жиру необходимость отпала

Если коммит совсем крохотный и нет таски, то просто словами пишу что сделано, например,
MyClass.MyMethod removed old code
или
Added files: img1.png, img2.png

Коммиты без комментов у нас запрещены свн-ом

MyClass.MyMethod removed old code
или
Added files: img1.png, img2.png
т.е. past tense ? ок

Вообще не задумывался никогда об этом, но да, как-то всегда past tense.
А какое по Вашему должно быть? present continuous? present perfect?

Вообще не задумывался никогда об этом, но да, как-то всегда past tense.
ну вроде как тогда грамматически неверно, т.е. тогда уж
files: img1.png, img2.png were added
А какое по Вашему должно быть? present continuous? present perfect?
ну мне хочется перфект. но судя по гуглю вариантов два — паст и императив

констатация факта, тем более на письме — это past simple

Номер из issue/bug — треккера.
И зачем париться? Главное что бы было понятно, что за коммит.
Если без номера, то просто написать — minor fix of blablabla, blablabla refactored, added blablabla for blablabla.

наверное номер бага очень круто смотрится при чери-пике или просмотре истории/мерже

Заголовок issue в скобочках. А если что-то не нравится, пиши плагин для интеграции треккера.

чери-пике
Ну и термины же понавыдумывали.
Ну и термины же понавыдумывали.
ну это комманда гита «cherry-pick»
пиши плагин для интеграции треккера
тут все не так просто — например может быть несколько коммитов для одного бага/issue, могут быть коммиты, не относящиеся к конкретным багам и.т.д.
Кстати, даже при такой плотной интеграции трекера, как на гитхабе, все равно пишут осмысленные комменты.
refactored, added blablabla for blablabla.
ага. т.е. past tense

видимо, неявно в виде существительного подразумевается сам коммит. Типа «комит фиксит ...». А не в прошедшем из-за того, что коммиты можно применять в любое время. Правда, тогда не понятно почему глагол без окончания «(e)s».
Но это все мои домыслы:)

Ссылка на задачу, если багтрекер отдельная тулза, + заголовок самой задачи. Писать Fixed, Added, Improved, Removed — дополнительно, а есть ли в этом смысл?

ну детали, что было сделано по-задаче

Пока никто не ответил, оставлю нагугленную SO-дискуссию:
stackoverflow.com/...commit-messages

Когда-то нашел очень неплохой и короткий гайд:
tbaggery.com/...t-messages.html

Подписаться на комментарии