掌握聚合最新动态了解行业最新趋势
API接口,开发服务,免费咨询服务

说明变更原因:让Git Commit Message变得更清晰明了

我最近在忙着处理一个第三方整合方面的问题,这个问题突然出现在我眼前,而且没有明显的原因。问题的来源,是页面上的一个iframe突然无法正常工作了。

我的第一反应,就是对包含这个iframe的那行代码进行git blame看看代码上一次改变是在什么时候,以及改变的内容。我立刻就发现了变更:

 - <iframe src="https://fake-3rd-party.com/widget?code=12345" />

+ <iframe src="https://fake-3rd-party.com/embed/WXYZ" />

它意味着,在整合过程中,一个东西可能出现了改变,并且引发了这个问题。于是我开始查看commit message,试图找到更多的信息,我注意到:

 Author: Some Guy <some.guy@some.domain>

    changed iframe src

原来如此!多谢你了,Some Guy

但是故事还没有结束,我才刚刚开始要阐述我的观点。

当我们下次写commit message的时候,让我们花时间想一想,这个messege是否能够提供有用信息?我们是否应该在里面加一些其他的信息,让别人能理解究竟发生了什么?比如一个链接,或是其他能说明问题的东西。

如果你确实不知道应该写什么才能让message变得有用,你不妨问自己一个问题:我为什么要做出这个变更?考虑好这个问题之后,至少你可以将做出这次变更的动机写在message中。至少,在了解了你的动机之后,其他人在进行深一步的调查的时候能更轻松一点。

从现在开始,我们应该将这种为什么要进行变更的内容,写在commit message中。

sdk.jpg

原文来自:SDK.cn

声明:所有来源为“聚合数据”的内容信息,未经本网许可,不得转载!如对内容有异议或投诉,请与我们联系。邮箱:marketing@think-land.com

  • 航班订票查询

    通过出发地、目的地、出发日期等信息查询航班信息。

    通过出发地、目的地、出发日期等信息查询航班信息。

  • 火车订票查询

    通过站到站查询火车班次时刻表等信息,同时已集成至聚合MCP Server。火车票订票MCP不仅能赋予你的Agent火车时刻查询,还能支持在线订票能力。

    通过站到站查询火车班次时刻表等信息,同时已集成至聚合MCP Server。火车票订票MCP不仅能赋予你的Agent火车时刻查询,还能支持在线订票能力。

  • 车辆过户信息查询

    通过车辆vin码查询车辆的过户次数等相关信息

    通过车辆vin码查询车辆的过户次数等相关信息

  • 银行卡五元素校验

    验证银行卡、身份证、姓名、手机号是否一致并返回账户类型

    验证银行卡、身份证、姓名、手机号是否一致并返回账户类型

  • 高风险人群查询

    查询个人是否存在高风险行为

    查询个人是否存在高风险行为

0512-88869195
数 据 驱 动 未 来
Data Drives The Future