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

Pek*_*ica 6 svn

我喜欢在我的subversion提交消息中使用markdown表示法,计划有一天创建一个"log"函数,它将在HTML页面中输出提交消息,这与Trac的"历史"视图不同.(如果到目前为止,Trac没有一个降价插件用于此目的.)

任何人都可以想出任何反对这个的理由吗?

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

Joh*_*lla 3

有人能想到任何反对这一点的理由吗?

是的:提交应该是简单、朴实的文本,以鼓励最少的提交消息。如果您需要这种格式,那么您的提交消息并没有清楚地解释消息的目的。一般来说,提交消息应该简短、简洁地描述更改,不超过两到三句话。如果需要更多细节或上下文,他们可以参考外部问题(例如“修复问题#184图形错误”)。

如果这不仅仅是个人偏好,并且您的提交实际上确实需要大量细节和格式来解释,那么它们可能太大,应该分解为更小、更容易消化的块。

  • 我有时在修复相关错误或在一次提交中实现相关功能时使用列表。 (2认同)
  • MarkDown 的伟大之处在于它的“原始”形式仍然具有很强的可读性。因此,即使您查看未经 MarkDown 处理的“原始”Subversion 日志,它也不会真正妨碍您。 (2认同)