Сервисы Digital Skynet
455

Как лучшие практики Git спасают от переработки

Недавно я работал над задачей обновления сертификата для приложения NodeJS. Последнее обновление было 2 года назад. Приложение устарело. Модули Core-NodeJS-Infra не обновлялись, а службы переадресации устарели. и сроки работы над задачей были очень ограничены. Все это можно было сравнить с поездкой на американских горках.

В закладки

Я потратил три дня на запуск приложения.

Обновлены ли Infra-модули?

Все службы работают нормально?

Потоки пользовательского интерфейса работают нормально?

Один из членов моей команды начинал обновлять приложение больше года назад. Он сказал, что репозиторий, откуда я создавал ветку, был уже ответвленный.Раньше другая команда работала над этим репо, а затем наша. Полный беспорядок!

У нас есть инструмент «Ownership», который показывает правильное репо и он «лгал» мне. Ситуация была такой:

Я должен был работать в реальном репо, но вместо этого я работал над другой веткой. Как же глупо!

Первая мысль — три дня работы потрачены впустую и нужно начинать все заново.

Вторая мысль? Спросить моего старого друга Git. Он помогал мне в течение долгого времени.

Я — “Привет, Git! Я в полной… в общем, у меня проблема, и мне нужна помощь!”

Git — “Привет, не беда! Создай новую ветку и назови upgrade, и добавь в нее работающий код. Для этого можешь использовать git hard reset.

Я — “Попробуем.”

Ситуация стала выглядеть так:

Git — “Нам нужно знать, что изменилось между разработкой и обновлением. Можем ли перечислить файлы, которые отличаются между upgrade и develop? Проверь эти файлы по отдельности и выясни, какие изменения произошли.”

Я — “Круто. Я вижу три вида изменений. Есть сервис S1, который мне нужно вызвать по-другому. Есть сервис S2, который мне нужно вызвать с использованием другой конечной точки. Есть сервис S3, который мне нужно вызвать с использованием разных параметров. Я также вижу, что файл package.json в ветке обновления имеет некоторые из уже обновленных пакетов. Поэтому нужно изменить только несколько пакетов.”

Git — “Здорово, что ты разделил изменения. Теперь покажи мне журнал Git твоей ветки. Надеюсь, ты следовал некоторым базовым практикам Git. Например, в каждом коммите у тебя код, который билдится”.

Я — “Да, у меня есть всего четыре коммита в ветке develop. Один из коммитов делает проект рабочим.”

Git — “Прекрасно! Похоже, ты правильно следовал лучшим практикам. Начнем со стабилизации сборки проекта с создания пакета.json up-to-date. Зайдите в ветку upgrade и сделайте дубликат package.json и package-copy.json. Теперь, используя Git replace, upgrade/package.json с develop/package.json, и запустите diff между package.json и package-copy.json.

Я — “Сейчас попробую. Хорошо, всё билдится и работает.”

Коммитьте только связанные изменения

Сделайте паузу на мгновение и подумайте, должно ли это изменение быть в этом коммите. Коммит, который говорит, что «change: service-s1 endpoints» и имеет изменения service-s2, просто создаст путаницу.

Не коммитьте половину работы

Знакома фраза “коммитьте как можно скорее, коммитьте часто”? Однако это не всегда полезно. Во всем должна быть последовательность и логика. Если с вашим кодом будет работать другой человек, будет ли ему полезна наполовину сделанная работа? Нет.

Тестируйте код перед коммитами

Не забывайте, что Git - это машина, как любая машина, он должен быть рабочим всегда.

Пишите хорошие комментарии к коммитам

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

Заключение

Ошибки случаются у всех. Git наведет порядок в вашей работе. Я поклонник сообщений Git semantic commit, которые помогают отслеживать историю в Git. Согласитесь, вы не можете ожидать от других качественных комментариев к каждому коммиту, но вы можете отслеживать тип сообщений.

Git поддерживается VSCode. Так проще видеть конфликты и разрешать их, иногда всего лишь одним щелчком мыши. Как в примере ниже.

Перевод статьи How Git best practices saved me hours of rework от Digital Skynet

Материал опубликован пользователем. Нажмите кнопку «Написать», чтобы поделиться мнением или рассказать о своём проекте.

Написать
{ "author_name": "Digital Skynet", "author_type": "self", "tags": [], "comments": 4, "likes": 6, "favorites": 4, "is_advertisement": false, "subsite_label": "services", "id": 50221, "is_wide": false, "is_ugc": true, "date": "Tue, 06 Nov 2018 09:22:50 +0300" }
{ "id": 50221, "author_id": 187179, "diff_limit": 1000, "urls": {"diff":"\/comments\/50221\/get","add":"\/comments\/50221\/add","edit":"\/comments\/edit","remove":"\/admin\/comments\/remove","pin":"\/admin\/comments\/pin","get4edit":"\/comments\/get4edit","complain":"\/comments\/complain","load_more":"\/comments\/loading\/50221"}, "attach_limit": 2, "max_comment_text_length": 5000, "subsite_id": 200396 }

4 комментария 4 комм.

Популярные

По порядку

0

Ну и зачем оно тут, если есть хабр?

Ответить
2

На Хабре это схватило бы 100500 минусов и никогда не вышло из песочницы. А здесь можно с гордостью писать: "Хабр уже не торт. Все мои бородатые друзья-хакеры оттуда ушли. Я держался до последнего."

Ответить
0

Хабр уже не торт 😏

Ответить
0

o_O

Ответить
0
{ "page_type": "article" }

Прямой эфир

[ { "id": 1, "label": "100%×150_Branding_desktop", "provider": "adfox", "adaptive": [ "desktop" ], "adfox_method": "createAdaptive", "auto_reload": true, "adfox": { "ownerId": 228129, "params": { "pp": "g", "ps": "bugf", "p2": "ezfl" } } }, { "id": 2, "label": "1200х400", "provider": "adfox", "adaptive": [ "phone" ], "auto_reload": true, "adfox": { "ownerId": 228129, "params": { "pp": "g", "ps": "bugf", "p2": "ezfn" } } }, { "id": 3, "label": "240х200 _ТГБ_desktop", "provider": "adfox", "adaptive": [ "desktop" ], "adfox": { "ownerId": 228129, "params": { "pp": "g", "ps": "bugf", "p2": "fizc" } } }, { "id": 4, "label": "240х200_mobile", "provider": "adfox", "adaptive": [ "phone" ], "adfox": { "ownerId": 228129, "params": { "pp": "g", "ps": "bugf", "p2": "flbq" } } }, { "id": 5, "label": "300x500_desktop", "provider": "adfox", "adaptive": [ "desktop" ], "adfox": { "ownerId": 228129, "params": { "pp": "g", "ps": "bugf", "p2": "ezfk" } } }, { "id": 6, "label": "1180х250_Interpool_баннер над комментариями_Desktop", "provider": "adfox", "adaptive": [ "desktop" ], "adfox": { "ownerId": 228129, "params": { "pp": "h", "ps": "bugf", "p2": "ffyh" } } }, { "id": 7, "label": "Article Footer 100%_desktop_mobile", "provider": "adfox", "adaptive": [ "desktop", "tablet", "phone" ], "adfox": { "ownerId": 228129, "params": { "pp": "g", "ps": "bugf", "p2": "fjxb" } } }, { "id": 8, "label": "Fullscreen Desktop", "provider": "adfox", "adaptive": [ "desktop", "tablet" ], "auto_reload": true, "adfox": { "ownerId": 228129, "params": { "pp": "g", "ps": "bugf", "p2": "fjoh" } } }, { "id": 9, "label": "Fullscreen Mobile", "provider": "adfox", "adaptive": [ "phone" ], "auto_reload": true, "adfox": { "ownerId": 228129, "params": { "pp": "g", "ps": "bugf", "p2": "fjog" } } }, { "id": 10, "disable": true, "label": "Native Partner Desktop", "provider": "adfox", "adaptive": [ "desktop", "tablet" ], "adfox": { "ownerId": 228129, "params": { "pp": "g", "ps": "clmf", "p2": "fmyb" } } }, { "id": 11, "disable": true, "label": "Native Partner Mobile", "provider": "adfox", "adaptive": [ "phone" ], "adfox": { "ownerId": 228129, "params": { "pp": "g", "ps": "clmf", "p2": "fmyc" } } }, { "id": 12, "label": "Кнопка в шапке", "provider": "adfox", "adaptive": [ "desktop" ], "adfox": { "ownerId": 228129, "params": { "p1": "bscsh", "p2": "fdhx" } } }, { "id": 13, "label": "DM InPage Video PartnerCode", "provider": "adfox", "adaptive": [ "desktop", "tablet", "phone" ], "adfox_method": "createAdaptive", "adfox": { "ownerId": 228129, "params": { "pp": "h", "ps": "bugf", "p2": "flvn" } } }, { "id": 14, "label": "Yandex context video banner", "provider": "yandex", "yandex": { "block_id": "VI-223676-0", "render_to": "inpage_VI-223676-0-1104503429", "adfox_url": "//ads.adfox.ru/228129/getCode?pp=h&ps=bugf&p2=fpjw&puid1=&puid2=&puid3=&puid4=&puid8=&puid9=&puid10=&puid21=&puid22=&puid31=&puid32=&puid33=&fmt=1&dl={REFERER}&pr=" } }, { "id": 15, "label": "Плашка на главной", "provider": "adfox", "adaptive": [ "desktop", "tablet", "phone" ], "adfox": { "ownerId": 228129, "params": { "p1": "byudx", "p2": "ftjf" } } }, { "id": 16, "label": "Кнопка в шапке мобайл", "provider": "adfox", "adaptive": [ "tablet", "phone" ], "adfox": { "ownerId": 228129, "params": { "p1": "byzqf", "p2": "ftwx" } } }, { "id": 17, "label": "Stratum Desktop", "provider": "adfox", "adaptive": [ "desktop" ], "auto_reload": true, "adfox": { "ownerId": 228129, "params": { "pp": "g", "ps": "bugf", "p2": "fzvb" } } }, { "id": 18, "label": "Stratum Mobile", "provider": "adfox", "adaptive": [ "tablet", "phone" ], "auto_reload": true, "adfox": { "ownerId": 228129, "params": { "pp": "g", "ps": "bugf", "p2": "fzvc" } } }, { "id": 19, "label": "Тизер на главной", "provider": "adfox", "adaptive": [ "desktop", "tablet", "phone" ], "auto_reload": true, "adfox": { "ownerId": 228129, "params": { "p1": "cbltd", "p2": "gazs" } } } ]
Приложение-плацебо скачали
больше миллиона раз
Подписаться на push-уведомления
{ "page_type": "default" }