Какой стиль вы используете для своих сообщений о совершении? Технический или функциональный?

Допустим, вы работаете над некоторыми типами веб-приложений. Вот две разные версии сообщений фиксации для одного и того же набора изменений.

  1. Перенаправление пользователя в user_profile для общедоступных контроллеров -или- Ограничение входа в систему пользователя, доступ к открытым контроллерам
  2. Добавьте require_guest перед фильтром в нужные контроллеры

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

Итак, какой из них вы предпочитаете? и почему?

DRY применяется для сообщений фиксации, поэтому не повторяйте ничего, что вы можете видеть из кода / diff.

Вместо этого создайте контекст: укажите номер билета, который вызвал изменение, объясните, почему вы это сделали, дайте 10-тысячный вид изменения.

Пример: «Убедитесь, что только проверенные пользователи могут получить доступ к закрытым страницам» вместо «Добавлены вызовы AccessController». Я вижу последний из diff, но diff не объясняет, почему вы сделали это изменение.

Я предпочел бы иметь сообщение фиксации, которое упоминает оба конца соединения:

New require_guest before filter redirects users to user_profile for public controllers 

вы должны, вероятно, упомянуть оба, а также номер билета, если вы используете что-то вроде Trac или RedMine