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

Подскажите как правильно писать комиты для проекта.
Моя задача делать верстку и передавать ее программисту. Какие моменты и изменения лучше комментировать: добавление плагинов, рефакторинг, добавление страниц. Что еще?
У кого был опыт контроля версий верстки, поделитесь опытом)
  • Вопрос задан
  • 2023 просмотра
Решения вопроса 1
@kazmiruk
Я всегда делаю так:
- по фичи\багу\рефакторингу завожу таск, в котором описываю задачу;
- создаю ветку, делаю все, что нужно;
- каждый коммит сопровождаю следующим refs #< task_id >: <краткое описание внесенных изменений> (если в коммите вдруг поднялась рука затронуть несколько тасков, то refs #< task_id >, #< task_id >, но лучше так не делать);
- когда фича готова вливаю ее в основную ветку с сохранением истории коммитов;
- вношу изменения в таск трекере - описываю решение (что изменилось, что сделал, как сделал), закрываю таск.

Так я поступаю даже когда работаю один. Потом легко по номеру таска просматривать историю, узнавать к какому таску относились данные изменения и история не перегружена длинными историями "как я провел лето". Ну и бонус: таск трекеры умеют собирать информацию сформированную в некотором стандартизированном виде.
Ответ написан
Пригласить эксперта
Ответы на вопрос 2
POS_troi
@POS_troi
СадоМазо Админ, флудер, троль.
Это вечная проблема :)
1296_v6.png
xkcd

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

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы