А вы правильно оформляете commit-message?

Я надеюсь, что да, но на всякий случай приведу несколько распространенных рекомендаций по оформлению коммитов. Если я что-то упустил, жду вас в комментариях.
🔹Длина заголовка коммита не должна превышать 50 символов
Это сделано исключительно для удобства чтения журнала проекта.
🔹Формат заголовка коммита зависит от соглашений в конкретной команде.
В разных проектах разные требования к формату заголовка. Например, есть требование в начале заголовка размещать номер тикета: "WTF-42: some question fix". Или же в начале заголовка указывать компонент, в который были внесены изменения "tests: unit: add some question test". Точка в конце заголовка не ставится.
🔹Заголовок коммита содержит краткое описание проделанных изменений.
Заголовок коммита должен отвечать на вопрос: какие изменения были сделали в проекте? Не более. Подробности и причины сделанных изменений нужно перенести в тело коммита.
🔹Между заголовком коммита и телом нужно оставлять пустую строку.
Очередная рекомендация, которая повышает читаемость журнала. В консоли эта рекомендация не сильно заметна, а вот GitLab и GitHub с помощью пустой строки умеют отображать заголовок коммита и скрывать его тело.
🔹Тело коммита не ограничено, а вот строка в теле коммита не должна превышать 72 символа.
Тело коммита не является обязательным, но его наличие позволяет без изучения кода лучше понять, что и почему было сделано. Т.е. если был исправлен баг, то нужно описать условия при которых он проявлялся и каким образом был исправлен. Если новая фича, нужно написать на основе каких требований она была добавлена. Можно приложить ссылки на спецификации, обсуждения, но нужно быть уверенным, что ссылки останутся актуальными через несколько лет. Важно: не нужно писать в теле коммита, как вы делали задачу.
🔹Уточните, нужно ли подписывать коммит.
Чаще всего это требование встречается при работе с open source продуктами. Коммит подписывается с помощью закрытого ключа, таким образом, вы подтверждаете вашу идентичность.

p.s.: а еще шаблон коммита можно прописать в git pre-commit hook

Технические посты тут t.me/neverending_cpp

Лига программистов

2.1K постов11.9K подписчика

Правила сообщества

- Будьте взаимовежливы, аргументируйте критику

- Приветствуются любые посты по тематике программирования

- Если ваш пост содержит ссылки на внешние ресурсы - он должен быть самодостаточным. Вариации на тему "далее читайте в моей телеге" будут удаляться из сообщества

0
Автор поста оценил этот комментарий

Заходишь в задачу и смотришь что надо было сделать, очень просто

И вот тебе четкое ТЗ, для этого нужно сделать 1 клик

А дальше читай код

Зачем описывать что-то текстом, если это уже описано кодом? В этом нет смысла. Это во-первых.

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

раскрыть ветку (1)
0
Автор поста оценил этот комментарий

Следующий вопрос. А что будет, если кампания переедет с Jira на, например, ЯндексТрекер (или как его там)? А при переезде многолетняя истории задач частично потеряется. Или менеджмент примет решение перенести задачи только за последний год?

0
Автор поста оценил этот комментарий

Заходишь в задачу и смотришь что надо было сделать, очень просто

И вот тебе четкое ТЗ, для этого нужно сделать 1 клик

А дальше читай код

Зачем описывать что-то текстом, если это уже описано кодом? В этом нет смысла. Это во-первых.

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

раскрыть ветку (1)
0
Автор поста оценил этот комментарий

У вас был опыт работы с open source?

3
Автор поста оценил этот комментарий

Что за бред.

Перед вами выхлоп git log в 100 коммитов вида "task #124". Определите на глаз какой коммит что делал.

раскрыть ветку (1)
0
Автор поста оценил этот комментарий

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

1
Автор поста оценил этот комментарий

🔹Длина заголовка коммита не должна превышать 50 символов
Это сделано исключительно для удобства чтения журнала проекта.

49, 197, 56 единичек.


Как же так вышло? А вот как.
Закиньте афтора в чс

Иллюстрация к комментарию
Иллюстрация к комментарию
Иллюстрация к комментарию
Иллюстрация к комментарию
раскрыть ветку (1)
Автор поста оценил этот комментарий

Что вас смущает? То, что я собрал все известные мне рекомендации в одном посте?

показать ответы

Темы

Политика

Теги

Популярные авторы

Сообщества

18+

Теги

Популярные авторы

Сообщества

Игры

Теги

Популярные авторы

Сообщества

Юмор

Теги

Популярные авторы

Сообщества

Отношения

Теги

Популярные авторы

Сообщества

Здоровье

Теги

Популярные авторы

Сообщества

Путешествия

Теги

Популярные авторы

Сообщества

Спорт

Теги

Популярные авторы

Сообщества

Хобби

Теги

Популярные авторы

Сообщества

Сервис

Теги

Популярные авторы

Сообщества

Природа

Теги

Популярные авторы

Сообщества

Бизнес

Теги

Популярные авторы

Сообщества

Транспорт

Теги

Популярные авторы

Сообщества

Общение

Теги

Популярные авторы

Сообщества

Юриспруденция

Теги

Популярные авторы

Сообщества

Наука

Теги

Популярные авторы

Сообщества

IT

Теги

Популярные авторы

Сообщества

Животные

Теги

Популярные авторы

Сообщества

Кино и сериалы

Теги

Популярные авторы

Сообщества

Экономика

Теги

Популярные авторы

Сообщества

Кулинария

Теги

Популярные авторы

Сообщества

История

Теги

Популярные авторы

Сообщества