Использование markdown в сообщениях коммитов Subversion - есть мысли?

Question

Мне нравится использовать нотацию уценки в моих сообщениях коммитов subversion, планируя однажды создать функцию «log», которая будет выводить сообщения коммитов на HTML-странице, в отличие от представления Trac «history». (Если у Trac к тому времени не будет плагина уценки, именно для этой цели.)

Кто-нибудь может придумать какие-либо причины против этого?

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

Answer 1

Кто-нибудь может придумать какие-либо причины против этого?

Да: коммиты должны быть простым, неукрашенным текстом, чтобы поддерживать минимальное количество коммитов. Если вам нужно такое форматирование, ваши коммит-сообщения не содержат четкого объяснения цели сообщения. В целом, сообщения о фиксации должны быть краткими, краткими описаниями изменений, не более двух или трех предложений . Если требуется больше подробностей или контекста, они могут ссылаться на внешние проблемы (например, «Исправлена ​​проблема с графической ошибкой # 184»).

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

Answer 2

Я использую trac, который использует разметку Wiki для всего (я только что проверил, и он также используется в журналах фиксации). Я в основном использую * или - для списков, и trac показывает их правильно.

При следующем коммите я посмотрю, принимает ли он обратные метки (или {{{ и }}}, что также принимается в вики-разметке), но, скорее всего, будет.

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