6 worst commit messages in GIT. And how to compose a proper commit message in GIT.
HTML-код
- Опубликовано: 30 июн 2024
- Привет друзья! В этом видео я хочу поделиться с вами 6-ю видами неинформативних commit messages, которых стоит избегать в ваших репозиториях.
Наверняка вам попадались такие коммит мессаджи как "fix" или "added tests". А может вы и сами иногда такое писали ;) Информативность этих сообщений стремится к нулю, собственно, как и возможность другим разработчикам понять и разобраться, что содержится в этом коммите.
После того, как мы разберемся, как не надо писать коммит мессаджи, мы поговорим о том, как все сделать правильно и научимся оформлять идеальный commit message в GIT.
Таймкоды:
00:00 А вы тоже так делали?
00:28 6 худших коммит мессаджей
02:01 А как все-таки надо делать?
02:48 Поделись этим видео с коллегой, который пишет такие страшные коммит сообщения :)
---
Если видео было для вас полезным, ставьте лайк и поделитесь им с друзьями.
Подписывайтесь на наш канал: bit.ly/fs-ytb
---
Присоединяйтесь к нам в соцсетях:
FB: / frontendscience
Instagram Сергея Пузанкова: / puzankovcom
Заходите на наш сайт: frontend-science.com/
--
Music:
New Shoes by Blue Wednesday
#git #frontend
Спасибо за видео! Сделал мое утро :)
Мое любимое это WIP :)
Рад, что понравилось! :) wip - тоже отличный вариант :)
Еще не плохо 'change header' и изменения в 15 файлах :)
Это уже отдельная тема для разговора. Как правильно готовить коммит. :)
Спасибо. Полезно очень 😎🤖
Рад, что было полезно!
Супер!!!! Спасибо!!!! Подписываюсь однозначно.
Информативно!)
Про commit description впервые услышал, спасибо за то что расширяете мои горизонты знаний🤯
I like the video before watching it because I know that it would be perfect, it is about your all videos.
Thank you for your work.
В смысле "куда вы потом деваете сэкономленное время"? Смотрим видео Сереги Пузанкова :)
Хороший подход/стиль ангуляровских коммитов (AngularJS Git Commit Message Conventions).
Как вариант еще можно коммитить отталкиваясь от события
add: ... что было добавленно
rm: ... что было удалено, и так далее в таком духе
fix, update, change, upload, init, ref
Спасибо за видео.
Мои коллеги пишут коммиты в стиле
fix: иконки маркеров при сборке
Ну это даже вполне информативный коммит выходит. Понятно что это фикс и понятно какую область фиксили. Если бы еще добавить что за проблема с ними была. Например: Fix broken colours of marker icons
Реальный список коммитов 4-летней давности в одном из наших проектов.
Возможно некоторые из них делал и я, т.к. тогда коммитили все с одного аккаунта:
fixed-error
pravki
pravki
fix-bugs
fix-bugs
pravki
pravki
pravki
Правка по привязке оборудования
dvoinoy-click-po-marke-cabelya-esli-neskolko-kabeley
Правка по привязке оборудования
Правка по привязке оборудования
позиционирование
позиционирование
позиционирование
позиционирование
позиционирование
позиционирование
позиционирование
ispravlenie-baga
Правка по привязке оборудования
Правка по привязке оборудования
Правка по привязке оборудования
fix-two-bugs
vse-chto-sdelal-do-pokaza
fix-trace-bug
True story 😂
У моего коллеги около тысячи коммитов в духе "123"😂
Насколько знаю есть специальный стайл гайд по написанию коммитов. Другой вопроос - можно ли писать коммиты на русском?
Можно, если вы работаете исключительно на русскоязычном проекте.
Нужна самодисциплина чтобы грамотно делать коммиты)
Это точно! Это же надо напрячься и придумать качественное описание!
"my commit"
My test
зачастую достаточно указать номер тикета в джире, а при мердже делать сквош
действительно, наличие Jira id это замечательный способ связать коммит со всей той информацией которая храниться в тасктрекере. Но коммит мессаджи состоящие только лишь из IDшников - это тоже антипатерн. Зайдя в git log - по истории нельзя быстро разобраться что коммитилось. Для каждого id - прийдется копировать его и искать в jire что же это было. Хороший вариант "JIRA-123 Title of jira ticket". Причем в как раз в jira можно настроить дополнительное поле для всех типов тасков/багов/стори, которое так и называется commit message (id + title) остается его просто скопировать и вставить.
проще всего поставить commitlint и придерживаться Conventional Commits
Да пользительная штука! Использовал на нескольких проектах, причем совместно со spellchecker'ом - он не давал делать ошибки в коммит мессаджах :)
'Upd'
В конце видео ссылка на какой-то странный рассказ.
less code = refactoring.
провел рефакторинг, кода стало меньше )
minor change
смерджи коммиты и все. у тебя один коммит-месседж))
гениально! 😂
Зачем читать commit сообщения? Какую ценную информацию вы извлекаете? (при условии что у вас коммит под пулреквестом, а он присоеденен к задаче)
А сколько Вы собираетесь тратить времени на то, чтобы разобраться - что в каком коммите находится, если у Вас будут айдишники? По каждому коммиту ходить в жиру и смотреть название и описание задачи? Не самая разумная и эфеективна трата рабочего времени. У меня на текущем проекте за 1 день в репозитории появляется 50 новых коммитов. А есть команды и побольше.
@@frontendscience а.. Наверное при такой организации труда это действительно нужно. Что касается неразумной траты времени - читать 50 хорошо оформленных коммитов тоже трата времени. Если вы используете жиру, то атласиан ещё предлагает битбакет и очень удобно с ним интегрируется. Хождение из задачи в пул реквест и обратно там связан ссылками. Там есть и другие фичи из-за чего необходимость чтения коммитов для сопоставления с задачей отпадает.
У меня только 2 варианта это "wip" и "all"
😂
Вода
Кофе
Ну а как еще могут написать те кто считает что английский не обязателен)
А при чем тут английский?
Самый простой способ написать коммит - скопировать таск по которому собственно выполнено задание = профит)
Так-то можно и на китайском коммитить 你知不知道？
Короче странный комментарий, к чему тут инглиш🤔
@@user-qu8eb3ii1l по сколько строк у тебя средний коммит выходит и сколько примерно людей на проекте? Если таск состоит из нескольких классов ты их все одним коммитом лепишь или имеется ввиду что кто-то для тебя декомпозирует таски, описывает их на английском и ты делаешь их как неделимые единицы копируя таск в коммит месседж?
Конечно если у тебя на проекте принято делать коммиты на китайском - можно и на нем, только как это относится к нам не совсем понятно. Как только найдешь проект с китайскими коммитами за пределами китая сообщи) Хотя я замечал что некоторых в РФ приводит в ярость идея необходимости англоязычной терминологии и документации, но такие обычно не искали вакансии без английского за пределами РФ и по дефолту считают что все русскоязычные находятся в РФ.
@@venom5583 кого можно привести в ярость англоязычной терминологией? 🤔
Я имею ввиду что можно писать коммиты и на русском, и на английском, и даже на китайском. Мой комментарий был о том, что всегда можно при желании выйти из положения, а короткие fix, fixed etc. пишут не из-за незнания языков, а из-за плохой практики комментирования и вообще ужасной самоорганизации.
В том числе несоблюдения отраслевых стандартов
И да, я в Китае учусь. Не все русские в РФ)))
@@user-qu8eb3ii1l *можно писать коммиты и на русском, и на английском, и даже на китайском.*
Можно, но будет-ли у тебя при этом удовлетворяющий тебя своей широтой выбор места работы?)
*а короткие fix, fixed etc. пишут не из-за незнания языков, а из-за плохой практики комментирования и вообще*
Как будто от уровня владения языком это не зависит. Когда у людей не хватает словарного запаса коммиты как раз и превращаются в нечто подобное. Но причины конечно разнятся в зависимости от страны, у индусов они наверняка какие-то свои.
Кстати, насчет китая, ты случайно не в курсе как там с работой? А то китайцы иногда пишут с предложениями выкупить аккаунт на upwork( или оплатить покупку ноутбука с rdp). И стало интересно, это у них там сложности с работой или просто скам такой.
@@venom5583 работы в Китае хватает, не смотря на жесткие карантинные меры, которые были применены.
Страна просто огромнейшая, производит как устройства так и ПО для них в огромных количествах. Также внушительный внутренний рынок ПО.
Но это одна сторона медали, ведь большие фирмы требуют от соискателей многое. Также кроме огромных мегаполисов, есть и деревни (в том числе в горах), где и асфальта нет(но зато красиво очень!!!)
В общем жизнь сложная вещь, так в двух словах и не скажешь.
Ну и китайцы живут не только в Китае
У нас похуже. Пишут что-то в роде "1" либо "123"
😞сочувствую
мне стыдно теперь🥲