Uso di markdown in subversion commit messages - any thoughts?

Question

Mi piace usare la notazione di markdown nei miei messaggi di commit di subversion, progettando di creare una funzione di "log" che produrrà i messaggi di commit in una pagina HTML, non diversamente dalla vista "cronologia" di Trac. (Se Trac non ha un plug-in markdown per quel preciso scopo.)

Qualcuno può pensare a qualche ragione contro questo?

L'unica cosa speciale di questo che viene in mente è l'uso di backticks ma dovrebbero essere scappati come qualsiasi altra cosa, quindi non dovrebbe essere un problema.

Answer 1

Qualcuno può pensare a qualche motivo contrario?

Sì: i commit devono essere semplici, senza testo per incoraggiare messaggi di commit minimi. Se hai bisogno di quel tipo di formattazione, i tuoi messaggi di commit non stanno chiaramente spiegando lo scopo del messaggio. In generale, i messaggi di commit devono essere brevi, brevi descrizioni delle modifiche, non più di due o tre frasi. Se sono necessari più dettagli o contesto, possono fare riferimento a problemi esterni (ad esempio "Risolto problema grafico 184 bug").

Se questa non è solo una preferenza personale e le tue commit richiedono effettivamente una quantità significativa di dettagli e formattazione da spiegare, allora sono probabilmente troppo grandi e dovrebbero essere suddivise in blocchi più piccoli, più facilmente digeribili.

Answer 2

Io uso trac, che utilizza il markup Wiki per tutto (ho appena controllato e viene utilizzato anche nei registri di commit). Io uso principalmente * o - per gli elenchi e trac li mostra correttamente.

Al prossimo commit vedrò se accetta i backtick (o {{{ e }}}, che è anche accettato dal markup Wiki), ma molto probabilmente lo farà.

Non vedo un motivo per cui non dovresti utilizzare Markdown sui tuoi log e potresti creare un piccolo plug-in per il tuo sistema di gestione dei progetti e di bug/rilascio dei problemi.