Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
I like to use markdown notation in my subversion commit messages, planning to one day create a “log” function that will output the commit messages in a HTML page, not unlike Trac’s “history” view. (If Trac doesn’t have a markdown plugin by then for exactly that purpose.)
Can anybody think of any reasons against this?
The only thing special about this that comes to mind is the use of backticks but they should be escaped like anything else, so that shouldn’t be a problem.
Yes: commits should be plain, unadorned text to encourage minimal commit messages. If you need that sort of formatting, your commit messages are not clearly explaining the purpose of the message. In general, commit messages should be short, succinct descriptions of the changes, no more than two or three sentences. If more detail or context is needed, they can reference external issues (e.g. “Fixes issue #184 graphical bug”).
If this is not merely a personal preference and your commits actually do require a significant amount of detail and formatting to explain, then they are probably too big and should be broken up into smaller, more easily digested chunks.