Что лучше для небольших исправлений ошибок и небольших функций - называть ветки по номеру заявки или называть их по описанию функции?

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 с автозаполнением.

Если это прежде всего основано на мнении, пожалуйста, не стесняйтесь дать мне руководство о том, как это может быть лучше всего подходит для SO - но я думаю, что причины, которые я привел, могут быть исправлены / добавлены, чтобы дать эмпирический ответ.

— Codeman
источник

По моему опыту, лучшим наименованием веток для небольших исправлений ошибок и небольших функций часто было транковое соединение (объединение рано, объединение часто => нет необходимости выделять изменения без достаточного обоснования). Это, конечно, не относится к обратному переносу критических исправлений в код старых версий, работающих в рабочей среде, для которых изоляция оправдана более чем достаточно (и для которой, в свою очередь, вполне естественно называть ветви после заявок: в конце концов, вы не делаете что-то особенно значимое в качестве функции, вы просто исправляете конкретную критическую рабочую ошибку, имея конкретный билет)

— gnat

5

В этом случае кажется, что вы могли бы пойти на компромисс по соглашению об именах, которое имеет номер и описание:

Пример:

Команда-имя / (12345) -fix-что-SQL-ошибка

Команда-имя / (53719) -expand-HTTP-анализатор

Здесь действительно нет правильного ответа, он субъективен в зависимости от вашей точки зрения.

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

Редактировать:

Чтобы справиться с проблемой автозаполнения, вы можете поместить пронумерованный идентификатор в квадратные скобки. Таким образом, когда вы набираете ответвление, вы всегда набираете (чтобы увидеть ответвления. Из этого списка вы сможете увидеть пронумерованный идентификатор и описание. Просто введите пару цифр, вкладку, и она будет

— dmck
источник

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

— Codeman

Автозаполнение работает только с самого начала имени ветви? Вы можете поставить удостоверение личности в конце? Я не использую функцию автозаполнения, поэтому я незнаком с ней.

— DMK

да, это работает от начала до конца - если вы хотите получить, team-name/12345-my-ticket-fixвы должны team-name/123, по сути, ввести TAB.

— Codeman

@ Pheonixblade9 Смотрите мое редактирование для возможного решения, поставив (перед идентификатором не должно быть необходимости знать идентификатор при наборе имени ветви

— dmck

1

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

Я бы сказал, однако, что переход по номеру билета поможет легче запомнить, над какой веткой работать. Поскольку они напрямую связаны с номером вопроса, а не с описанием. Выполнение только описания, кажется, делает более трудным вспомнить, какой конкретно проблемой это должно быть, и может стать многословным, пытаясь избежать расплывчатости.

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

— Schleis
источник

0

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

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

Так что сделайте оба - пронумеруйте ветвь и добавьте очень короткое текстовое описание просто для проверки. Я бы поставил число первым - проклятие автозаполнения - так как вам все равно нужно знать текст ветки (например, «исправление ошибки для сервера» или «исправление ошибки для сервера»), вам все равно нужно знать если это начинается с f или b!)

— gbjbaanb
источник