Почему считается хорошей практикой описывать git коммиты в настоящем времени?

Я прочитал все виды учебников по Git, в том числе и официальные, и все они, кажется, говорят мне, что это хорошая практика и практика писать заметки коммитов Git в настоящем времени.

Это почему? В чем причина этого?

2 ответа

Решение

Git - это распределенная VCS (система контроля версий). Несколько человек могут работать над одними и теми же проектами. Он получит изменения из многих источников.
Вместо того, чтобы писать сообщения, которые говорят, что сделал коммиттер. Эти сообщения лучше рассматривать как инструкции о том, что будет сделано после применения фиксации к репо.

Так что напишите сообщение, как это

Исправить ошибку #1234

Вместо

Исправлена ​​ошибка № 1234

Относитесь к журналу git не к истории ваших действий, а к последовательности описаний того, что делают все коммиты.

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

Это просто (относительно) общее соглашение, поэтому сообщения в проекте читаются последовательно. Например, совет по отправке патчей в Git Documentation/SubmittingPatches,

  • опишите изменения в императивном настроении, например "make xyzzy do frotz" вместо "[этот патч] заставляет xyzzy do frotz" или "[I] поменял xyzzy на frotz", как если бы вы давали указания кодовой базе изменить его поведение,

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

Другие вопросы по тегам