如何标记由bugreport引起的更改日志条目?

时间:2014-10-03 12:22:48

标签: perl changelog

是否有规则如何标记更改日志中的错误修复,其中有人在GitHub或CPAN上报告错误?

1 个答案:

答案 0 :(得分:4)

MetaCPAN会自动将与RT#12345匹配的文本(其中12345是票号)转换为指向rt.cpan.org的链接。如果没有" RT",我相信一些像#12345这样的文本链接到您首选的错误跟踪器(如META.json中所示),例如,你的GitHub问题页面。我对此并不是100%肯定,因为我更喜欢将我的所有错误报告给rt.cpan.org。

无论哪种方式,我都倾向于包含一个明确的URL,以便那些没有在MetaCPAN上阅读更改日志的人受益。我还会注意到谁报告了这个错误。

有时会有人通过IRC或电子邮件告诉我有关错误的报告,因此它不会有问题编号。在这种情况下,我注意到谁报告了它,但没有提供链接。

这里是example of one of my changelogs。 Bug记者也最终出现在CREDITS files