Как правильно писать комментарии для контроля версий(git, bitbucket)?

Question

[robotcigan]

Подскажите как правильно писать комиты для проекта.
Моя задача делать верстку и передавать ее программисту. Какие моменты и изменения лучше комментировать: добавление плагинов, рефакторинг, добавление страниц. Что еще?
У кого был опыт контроля версий верстки, поделитесь опытом)

Answer 1

[kazmiruk]

Я всегда делаю так:
- по фичи\багу\рефакторингу завожу таск, в котором описываю задачу;
- создаю ветку, делаю все, что нужно;
- каждый коммит сопровождаю следующим refs #< task_id >: <краткое описание внесенных изменений> (если в коммите вдруг поднялась рука затронуть несколько тасков, то refs #< task_id >, #< task_id >, но лучше так не делать);
- когда фича готова вливаю ее в основную ветку с сохранением истории коммитов;
- вношу изменения в таск трекере - описываю решение (что изменилось, что сделал, как сделал), закрываю таск.

Так я поступаю даже когда работаю один. Потом легко по номеру таска просматривать историю, узнавать к какому таску относились данные изменения и история не перегружена длинными историями "как я провел лето". Ну и бонус: таск трекеры умеют собирать информацию сформированную в некотором стандартизированном виде.

Comments

[robotcigan]

спасибо, только начал пользоваться git и поэтому почти ничего не понял)

[kazmiruk]

robotcigan: в смысле из того, что я описал? ) Спрашивайте, постараюсь ответить.

[robotcigan]

kazmiruk: просто я еще не шарю, что такое таски и таск-трекер, что такое refs #< task_id > и с ветками работать тоже не умею

[kazmiruk]

Таски - задачи, таск-трекеры - системы, позволяющими ставить и контролировать эти задачи (https://github.com/niwinz/django-jinja/issues вот пример простенького таск трекера гитхаба, там можете увидеть список тасков, над которыми работает\работал автор). Это все не является частью git, это часть инфраструктуры, которую дают github и bitbucket, т. е. по сути отдельные части. Про ветки лучше почитать, иначе, при количестве разработчиков >1, кто работает с кодом Вы можете нарваться на проблемы, решить которые не всегда легко. Ну а "refs #:<комментарий>" это просто комментарий коммита, в котором Вы указываете номер таска, к которому относится коммит и сам комментарий

[robotcigan]

kazmiruk: спасибо, большое) теперь я понял, что нужно больше тратить времени на изучение git

Answer 2

[ТыжСисАдмин]

Это вечная проблема :)

xkcd

А по большему счёту, программисту фиолетово на то что вы там верстаете, разве только вы внесёте изменения в "динамическую" часть и от программиста потребуется внести изменения в какой либо партиал, но это он явно должен узнать не из ваших комментов в GIT.

Answer 3

[Пума Тайланд]

ну пишите так чтобы вам было понятно что вы сделали через неделю.