Допустимы ли такие коммиты?

Question

[Кирилл Щевелев]

Допустимо ли на проекте вести названия коммитов в таком формате:
Вести .md файл с описанием изменений, где под заголовками будет указана версия, общая версия и дата изменения (v. 1.2.3 (#255) — 01/01/2024), далее сам список изменений, а в коммите указывать название версии (v. 1.2.3).
Все эти коммиты делать в основной ветке, а между ними ответвляться и коммиты делать по Conventional Commits.

Answer 1

[Saboteur]

Если ты делаешь для себя, делай как хочешь.
Но смысл делать подобный .md файл немного отсутствует - есть же git log
Сейчас не совсем понятна мысль - ты хочешь автоматический change log, или тебе просто хочется иметь текстовый файлик?
Но в бренче может быть много коммитов, пока не закончишь фичу, и зачастую "чистовик" пишется уже при слиянии в основной ветке, со сквизом промежуточных коммитов.

Comments

[Aetae]

Насколько я понял он и хочет практически обычный фло с сквашами фича веток в основную. Его просто смущает, что история коммитов в основной ветке будет выглядеть как v1.2.3, v.1.2.4, v1.3.0... без пояснений.:)

[Кирилл Щевелев]

Идея в том, чтобы на сайте сделать раздел с динамическим списком "Обновлений", который будет браться ну либо с md, либо с JSON, не столь важно, но параллельно, чтобы это было и описанием чистовых коммитов, а точнее ссылкой на них.

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

[Saboteur]

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