Журнальные сообщения для контроля версий самостоятельно

Question

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

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

Я использую git, но этот вопрос более общий.

Answer 1

Для меня это зависит от характера исправления. Иногда это одно слово. «Резервное копирование» или «Копирование изменений». Однако, если что-то вызвало у меня много горя, я буду документировать свои изменения намного шире. Если это открытый исходный код, и я не буду там так долго, я документирую свои изменения очень широко. svn -diff (а затем документируйте все мои изменения таким образом ... :)

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

Я дам вам, что «исправленная ошибка» не очень хороша в журнале изменений, но если это простая ошибка, возможно, это и будет сделано.

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

Вы потратили 2 часа на исправление ошибки? Ага! Долгое сообщение.

Answer 2

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

Но время от времени я все еще ленив (или полусонно) и набираю вещи типа «исправлена ​​ошибка».

Answer 3

Вы должны размещать сообщения так же значимыми, как те, которые вы бы ввели в код с несколькими разработчиками. Как правило, небольшая разница между кем-то, кто смотрит на ваши изменения через пару дней, и вы смотрите на них через 12 месяцев. В обеих этих ситуациях есть хороший шанс, что человек, который не будет знать, почему это было сделано :-)

Я даже зашел так далеко, чтобы использовать правильный контроль над изменениями, даже для того, что я делаю соло. Это означает, что каждое изменение базы кода должно иметь либо запрос на изменение, либо отчет об ошибке (с полной документацией).

Это делает мою жизнь намного легче, когда мне нужно понять, почему что-то было сделано. У меня есть лучшее использование для моей «wetware», чем попытка запомнить каждое небольшое изменение и почему это было сделано. Гораздо лучше позволить машине запомнить это - его память намного лучше.

И, в моем мнении, если вы не можете беспокоиться об этом, не делайте этого вообще. Просто вернитесь к менталитету ковбоев-кодеров и приложите немного усилий.

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