您能推荐一个好的提交消息模板/指南在公司中执行吗？[关闭]

在Git中，可以设置并强制执行良好的提交模板。

您能推荐（最好是带有论点的）好的提交模板/准则在公司中执行吗？

我用

[Abc]: Message.

使用Add，Mod（ify），Ref（actoring），Fix，Rem（ove）和Rea（dability），可以轻松提取日志文件。

范例：

Add: New function to rule the world.  
Mod: Add women factor in Domination.ruleTheWorld().  
Ref: Extract empathy stuff to an abstract class.  
Fix: RUL-42 or #42 Starvation need to be initialised before Energy to avoid the nullpointer in People.  
Rem: freeSpeech is not used anymore.  
Rea: Removed old TODO and extra space in header.  

如果我有多条线，我会以最重要的顺序对它们进行排序。

我们使用以下内容：

[JIRA中的票证编号]：[消息：已完成] 例如-ABC-123：增加了按区域配置演示的功能。

在这种情况下，通过适当的集成，您将能够在问题跟踪器中获取更改/删除/添加的文件。但是，请注意，应尽可能避免使用ABC-123：已完成或ABC-123：已通过过滤器修复的措施。

有一个简单的规则，这是一个约定，许多（如果不是全部）SCM和与SCM一起使用的大多数工具都遵循该约定：

提交消息的第一行是简短的摘要，而消息的其余部分包含详细信息。

因此，大多数工具仅显示第一行，并按需显示整个消息。

提交消息的典型滥用是项目符号更改列表（仅显示第一个项目符号）。另一个误用是在一行上写了一个详细的消息。

因此，如果有一件事情需要执行，我会说这是第一行的最大长度。

我个人从未见过值得使用的通用提交模板。评论应简明扼要地说明提交与哪些内容有关，例如，哪些功能/错误修复或简要说明更改原因。

不应包含有关已提交内容的信息，这可以由scm系统确定。更多的错误/功能信息属于跟踪错误和功能的位置。

提交后更新错误报告时，我发现最好在错误报告中注明提交修订以及注释。这样，您就可以找到从提交注释到错误报告的方式，对于错误报告中的每个注释，您都可以找到已提交的内容，但是不会在错误报告和提交消息中同时包含信息，因此不会重复信息。

然后，在查看文件修订历史时，您不仅可以看到描述历史的简短消息，而且还知道在哪里可以找到更多详细信息，错误报告或任务说明以获取更多详细信息。

在Git中，几乎可以使用Git钩子强制执行任何操作。查看.git / hooks中的示例以获取想法。

至于该消息，在一个非常普通的情况下，您希望包含有关所要解决的问题以及解决方案本身的足够信息，以便以后能够找到并识别此提交。在大多数情况下，将以错误编号（与错误跟踪系统正确集成）作为问题的参考。如果您的流程与其他系统集成在一起（例如代码审查跟踪系统），则还包括相应的位：

Extracted checking foobar range from bar() into foo(min, max) to re-use
in yadda() and blah(). foo() returns true if foobar is in the
specified range and false otherwise.

BugID: 123456
ReviewedBy: mabuddy
AutomergeTo: none

但您想保持简单。否则，人们将找到一种方法来欺骗系统并产生无用的提交消息。

我们使用的模板包含

• 错误/功能/修复的ID号
• 是/否描述代码是否经过测试
• 并在详细信息部分中简要说明了提交的意图

但是，大多数情况下前两个时间（大多数情况下都是三个）都被忽略了，因此这并不是什么大问题。

通常，我会在所使用的票务跟踪系统中找到标识符，或者将其作为第一行进行简要介绍。然后，我获得了提交中特定更改的行项目“项目符号”点。所以我可以这样：

MyVideoGameProject-123 OR Inventory System Improvements
Made inventory GUI drap and drap
Added ability to have multiple bag slots to expand inventory capacity

这是我喜欢的最干净的提交格式。这是直接而直接的。我这样做的另一个原因是，如果我要创建更改日志，则可以很容易地获取所有提交消息并将其解析为更改日志。

[ticketId] [ABC] [topicId] [WIP]消息，其中：

• ticketId-任务存储库中项目的ID
• ABC-添加（功能），修复（错误修复），str（结构），dep（依赖），rem（向后不兼容/删除），rea（可读性），ref（重构）
• topicId-可以是詹金斯和/或分支名称和/或gerrit的主题名称的作业选择器
• 在制品-是否在进行中（即持续集成可能需要这样做）
• 消息-修改的详细信息

示例：
[＃452567] [添加] [菜单项]新项目-留言簿
[＃452363] [修复] [banner_top] [WIP]现在可以使用
1024x300 [＃452363] [修复] [banner_top] 500x200现在可以使用
[ ＃452713] [rem] [page]左中间广告