我的项目遵循Conventional Commits指南v1.0.0,我有一个关于在提交消息头中包含问题代码的问题。假设我对代码“SPAN-500”有问题。虽然规范没有明确提到问题代码,但我在网上看到了这两个代码:
1.发行代码作为范围
feat(SPAN-500): add feat X to improve Y
字符串
1.发布代码作为后缀
feat: add feat X to improve Y [#SPAN-500]
型
如何正确地将问题代码添加到提交消息头中?
我希望确保提交消息遵循推荐的约定并保持一致性。任何指导或例子将不胜感激。
谢谢你,谢谢
1条答案
按热度按时间f2uvfpb91#
如何正确地将问题代码添加到提交消息头中?
您不应该将问题代码放在 header 中。按照网站上给出的例子:添加一个额外的 footer,如
Refs: #SPAN-500
。使用“scope”字段来放置问题代码不是一种选择,因为
一个作用域必须由一个名词组成,这个名词描述了代码库的一个部分,并用括号括起来。
并且
SPAN-500
不是代码库的一个部分,而是问题的代码。