x
 
Александр
13 июля 2017
Советы почтой каждую неделю
Пожалуйста, получите наше письмо, чтобы подтвердить свой адрес:
Вы подписаны на «Советы за неделю»:

Что писать в комментарии к коммиту?


Изменения в коммите (дифф) рассказывают, что изменилось. Единственный способ объяснить, зачем эти изменения и какая от них польза — комментарий к коммиту. Полезный комментарий описывает не изменения в коде, а их результат в мире разработчика:

7279242f add <div> wrap
# Плохо — это мы и в диффе видим. Зачем добавляли? Что исправляли?

7279242f fix Firefox issue with flexbox padding
# Хорошо — ясно, зачем изменения, какую проблему решали


b1d5272e placeholder
# Плохо — это что? О чём?

b1d5272e add missing placeholder to search input in header
# Хорошо — ясно, что поправили и зачем


4f5ed66 bump paperclip
# Плохо — зачем обновляли? На что повлияло?

4f5ed66 update paperclip: adds support for stream downloads for S3 objects
# Хорошо — paperclip обновили ради быстрого скачивания из S3

Отсюда правило: не что изменили, а что и зачем. Помимо этого правила я советую придерживаться ещё одного: писать на английском в повелительном наклонении.

Комментарии на английском синхронизированы с кодом: post в комментарии — post.rb в моделях. Если писать комментарии на русском, придется держать в голове словарь терминов: post.rb — это и «пост», и «статья», и «заметка».

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

51537554 mention Ubuntu installation instructions in README

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

Ещё по теме

P. S. Это был совет о веб-разработке. Хотите знать всё о коде, тестах, фронтенд-разработке, цеэсэсе, яваскрипте, рельсах и джейде? Присылайте вопросы.
Вёрстка и прототипирование — дисциплина Школы дизайнеров. Набор весной. Оставьте почту, и мы напишем вам, когда откроется следующий набор.
 

Поделиться
Отправить

Цель рубрики — обсуждение вопросов дизайна всех видов, текста в дизайне и взаимоотношений дизайнеров с клиентами.

Мы публикуем комментарии, которые добавляют к уже сказанному новые мысли и хорошие примеры. Мы ожидаем, что такие комментарии составят около 20% от общего числа.

Решение о публикации принимается один раз; мы не имеем возможности комментировать или пересматривать свое решение, хотя оно может быть ошибочно. Уже опубликованные комментарии могут быть удалены через некоторое время, если без них обсуждение не становится менее ценным или интересным.

Вот такой веб 2.0.

Как устроена беспарольная аутентификация почтой 7 Как вы проверяете соответствие вёрстки макету 2




Недавно всплыло

10 2 3 1