Що краще для невеликих виправлень помилок та невеликих функцій - називання гілок за номером квитка або називання їх за описом функції?

10

Я опинився в розбіжності (звичайно, сердечно) з моїм приводом щодо правильного іменування гілок. Це стосується виправлень помилок та невеликих гілок функцій, а не довго працюючих гілок функцій. Що стосується довготривалих галузей функцій, ми погоджуємось, що імена, які читаються людиною, краще. Ось дві точки зору:

Шахта:

Найменування відділень відповідно до їх команди та номера квитків краще. Це полегшує їх пошук у нашій системі квитків та коротший набір. Це також полегшує пошук відповідних відділень GIT під час пошуку історичної інформації про квиток.

Приклад:

team-name/12345
team-name/53719

Його:

Іменування гілок відповідно до їх особливості / функціональності. Це полегшує автоматичне заповнення і легше запам’ятовується, ніж окремі номери.

Приклад:

team-name/fix-that-sql-bug
team-name/expand-http-parser

Я запропонував один компроміс:

team-name/12345-fix-that-sql-bug

Але йому це не подобається, оскільки він псується з автозаповненням GIT.

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

— Кодеман
джерело

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

— gnat

5

У цьому випадку здається, що ви могли б піти на компроміс щодо конвенції про іменування, яка має і число, і опис:

Приклад:

team-name / (12345) -fix-that-sql-bug

назва команди / (53719) -expand-http-аналізатор

Тут справді немає правильної відповіді, вона суб'єктивна залежно від вашої точки зору.

Але якщо ви обидва підете на компроміс, ви отримаєте найкраще з обох світів. Я намагаюся пам’ятати про це, коли у моєї команди є подібні розбіжності.

Редагувати:

Щоб вирішити проблему з автозаповненням, ви можете помістити пронумерований ідентифікатор в дужки, таким чином, коли ви перейдете до типу гілки, яку ви завжди вводите (щоб побачити гілки. З цього списку ви зможете побачити пронумерований ідентифікатор та опис. Просто введіть пару чисел, вкладку, і це буде

— dmck
джерело

Я погоджуюся, і я додав це - я вважаю, що дурно не погоджуватися з цим компромісом.

— Codeman

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

— dmck

так, це працює від початку до кінця - якщо ви хочете отримати, team-name/12345-my-ticket-fixвам потрібно набрати team-name/123TAB, по суті.

— Кодеман

@ Pheonixblade9 Перегляньте мою редакцію для можливого рішення, поставивши (до того, як ідентифікатор повинен запобігти вам знати ідентифікатор під час введення імені гілки

— dmck

1

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

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

team-name/bug-that-has-specific-circumstances-to-occur-and-takes-alot-to-describe

— Шлейс
джерело

0

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

Я погоджуюсь, що посилання на трекер помилок є важливим (важливіше, ніж хороше ім'я, оскільки воно визначає саме проблему, яку вирішує галузь, якої немає декількох слів), але в той же час її зручність у використанні очікувати людей знати різницю між помилкою №7312 та №7213. Також неможливо очікувати, що люди кожен раз прийматимуть цілком правильні номери - одного дня хтось прихилиться до неправильної гілки, тому що вони неправильно прочитали / неправильно ввели 7312 за 7213. (хтось із моєї команди це зробив сьогодні!)

Тож зроби і те й інше - пронумеруй гілку та додай дуже короткий опис тексту лише для того, щоб діяти як чек. Я поставив би перше число - прокляття автозаповнення - так як ви все одно маєте знати текст гілки в будь-якому випадку (наприклад, "помилка-виправлення-для-сервера" або "виправлення-помилка-для-сервера" - вам все одно потрібно знати якщо це починається з f або b!)

— gbjbaanb
джерело