Оправдывает ли приведение вашего кода в порядок отдельный коммит в Git?

Установлено, что каждая отдельная фиксация Git должна быть одним логическим изменением. Также установлено, что этот производственный процесс часто бывает грязным (см. не быть скрытым - Сет Робертсон выступает за "Совершайте чаще, совершенствуйте позже".

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

  • Уточняющие комментарии
  • Изменение порядка функций для улучшения читаемости
  • Исправление отступов/пробелов
  • Удаление старых тестов, таких как // console.log(variables)

Тогда мой вопрос: рекомендуется ли сохранять эти «косметические» изменения в отдельном отдельном коммите? (И если нет, то как они должны быть зафиксированы?)

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

Помимо статьи Сета Робертсона, я прочитал следующие существующие вопросы, но нигде не могу найти ответ на свой вопрос:


git git-commit code-readability
person andydavies    schedule 18.05.2016    source источник
comment
вносить косметические изменения отдельно. Позже это поможет изолировать проблему, поскольку при поиске ошибки обычно можно пропустить всю фиксацию только косметических изменений.   -  person Gregg    schedule 18.05.2016
comment
stackoverflow.com/a/19656336/6194839 Я нашел это, просматривая ваши ссылки, так как согласен с тем, что должно быть стандарт. Вот что я хочу выделить из этой ссылки: ‹тип›(‹область›): ‹тема› ‹ПУСТАЯ СТРОКА› ‹тело› ‹ПУСТАЯ СТРОКА› ‹нижний колонтитул› Назначьте ‹тип› вашей фиксации как косметический.   -  person Bryce Drew    schedule 18.05.2016
comment
@BryceDrew Я понимаю, что ты имеешь в виду. Ваш комментарий побудил меня найти другие примеры авторитетных руководств по стилю, в которых перечислены различные «типы» фиксации и рекомендуемый префикс к сообщениям фиксации. Например, github.com/atom/atom/blob/ master/ (префикс 'art:' для изменения стиля) и udacity.github.io/ git-styleguide (префикс 'style:'). Это, как правило, предполагает, что существует соглашение о том, что изменения стиля являются допустимой фиксацией. Я бы добавил эти ссылки в качестве ответа, но, к сожалению, вопрос отложен.   -  person andydavies    schedule 20.05.2016

Ответы (1)


arrow_upward
1
arrow_downward

Да, косметические изменения должны быть отдельными. Это логическое изменение, отдельное от функциональных изменений. Кроме того, это упрощает просмотр функциональных изменений.

person FelipeC    schedule 18.05.2016