标记提交消息和变更集

Question

我正在寻找一个解决方案,在提交消息中标记变更集.

对我来说,"标签"是这样的:

• 代码清理
• 用户可见的变化
• 修改数据库结构(ALTER TABLE)
• 文档更改

到目前为止我使用SVN,但想切换到git.如果有标准,很多工具,如trac,redmine,......都可以使用它.

我希望这回答这样的问题:

• 如果我更新系统,客户可以看到哪些更改,或者只是维护更新？
• 两个版本之间的数据库架构是否已更改？

背景:

到目前为止,我使用unison在DEV,TEST和PROD系统之间进行同步.但是unison对版本管理一无所知(这是SVN的版本).我想切换到git.我希望看到快速,有什么变化.

示例:我想看看TEST和PROD之间的变化.我不希望看到源代码更改,但提交消息.但有时最多有100个提交.在这里,我想要一个过滤器,以排除不重要的更改.

Answer 1

我喜欢使用以下标签:

ADD adding new feature
FIX a bug
DOC documentation only
REF refactoring that doesn't include any changes in features 
FMT formatting only (spacing...)
MAK repository related changes (e.g., changes in the ignore list)
TEST related to test code only.

此标记始终是提交消息中的第一个内容,然后是问题跟踪系统中的简要说明和/或问题ID(如果存在).

我使用svn和git这些标签,到目前为止发现它们非常方便.

回答你的编辑:这就是我喜欢那些提交标签的原因.如果提交改变了行为,它立即可见.如果您的数据库方案经常更改或者这些更改或对您非常重要,您可以为此引入一个标记.

我还想在适当的时候在一个提交消息中组合这些标记.例如,"测试foo的测试DOC设置".

通过为数据库添加额外的数据库标记,您可以轻松跟踪与数据库相关的更改.

Answer 2

大多数时候，我使用Typo3的标签系统：http ://wiki.typo3.org/CommitMessage_Format_(Git ）

它在提交消息中使用标签，如下所示：[TAG] Short message 当然，我总是弹出问题编号以进行问题跟踪。我们正在使用JIRA，因此它将变成这样：[TAG] JIRA-123 Short message

Typo3标签：

可能的标签是：

• [功能]：一项新功能（也是少量新增功能）。它很可能是一项新增功能，但也可能被删除。这只能在v4的“ master”分支中发生，因为较旧的分支不允许使用新功能。例外情况必须与相应的发布管理器逐案讨论。
• [BUGFIX]：修正错误。
• [任务]：以上类别未涵盖的所有内容，例如编码样式清除。
• [API]：API已更改，方法或类已添加或删除；方法签名或返回类型已更改。这仅指TYPO3的公共API。

此外，在某些情况下可能会添加其他标志：

• [!!!]：重大变化。在此补丁程序之后，某些事情与以前有所不同，并且用户/管理员/扩展程序开发人员将不得不进行某些更改。应该只发生在“主人”身上。
• [WIP]：进行中。一旦更改的最终版本可用，该标志将被删除。标记为WIP的更改永远不会合并。
• [安全]：可视化更改已解决安全问题。该标签由安全团队使用，如果您发现安全问题，请务必先与安全团队联系！

示例主题描述：

• [BUGFIX]在tslib_fe中抛出HttpStatusExceptions
• [BUGFIX] [SECURITY]预准备语句中的SQL注入漏洞
• [FEATURE] [CONF]添加选项以隐藏列表mod中的BE搜索框
• [!!!] [FEATURE]将高级前端编辑移至TER
• [!!!] [任务]删除t3lib_sqlengine
• [!!!] [API]从t3lib_userAuth删除不推荐使用的方法redirect（）
• [API]为HTTP状态异常创建异常层次结构