在subversion中使用markdown提交消息 - 有什么想法吗？

Question

我喜欢在我的subversion提交消息中使用markdown表示法，计划有一天创建一个“log”函数，它将在HTML页面中输出提交消息，这与Trac的“历史”视图不同。 （如果到目前为止，Trac没有明确的降价插件。）

有人能想出任何反对此事的理由吗？

我想到的唯一特别之处是backticks的使用，但它们应该像其他任何东西一样被转义，所以这应该不是问题。

Answer 1

我使用trac，它将Wiki标记用于所有内容（我刚检查过，它也用于提交日志）。我主要使用*或-作为列表，并且trac正确显示它们。

在下次提交时，我会看到它是否接受反引号（或{{{和}}}，这也是Wiki标记接受的），但它很可能会接受。

我没有看到您不应该在自己的日志上使用Markdown的原因，并且可能会为您的项目管理和错误/问题跟踪系统创建一个小插件。

Answer 2

  

有人能想出任何反对此事的理由吗？

是的：提交应该是简单明了的文本，以鼓励最少的提交消息。如果您需要这种格式，您的提交消息不能清楚地解释消息的目的。一般来说，提交消息应该是简短的，简洁的变化描述，不超过两个或三个句子。如果需要更多细节或上下文，他们可以引用外部问题（例如“修复问题＃184图形错误”）。

如果这不仅仅是个人偏好，而且你的提交确实需要大量的细节和格式来解释，那么它们可能太大了，应该分解成更小，更容易消化的块。