发现自己的 commit 标题和内容越来越长了

查看 48|回复 3
作者:netabare   
大概是从四年级还是五年级做自己的项目开始,感觉好像就隐隐约约有倾向想要在 commit 里面写越来越多东西。一开始只是写比如从哪个 Stackoverflow 讨论串找到的参考资料,后来到一些算法或者设计上的东西,然后发现自己的 commit 标题越来越长,感觉长过头了就写进了 message 里面,然后就在 message 里面写 markdown 了。
上班后感觉好像这个倾向又被强化了,一方面摸鱼写的代码的 commit 很容易一个 commit 里面覆盖多个内容,而不是像写自己的项目那样细粒度到一两个文件,另一方面又总是担心意图没解释清楚别人难以理解自己的代码。
所以 commit 有时候就会长这样:
```markdown
[Core] (fix) Sorting algorithm, XXX Page, YYY Service
- Designed an algorithm to sort a certain dataset according to some requirements and constraints
- Included this algorithm into XXX page
- Extracted several methods to YYY service
- Removed deprecated codes
- Added test suite for subjects mentioned above
The algorithm scans the incoming dataset, which should conform to ..., at a first pass, it will ...
Some code has been refactored and reformatted.
```
不过也不总是这么长就是,如果 commit 改变的东西不多的话,那倒是经常一两个 bullet 就完了。
另外也感觉发 PR 的时候好像我总喜欢写得像 GitHub 的 readme 一样。
不过也听说是不是说长 commit 是新手的普遍操作,senior 的 commit 普遍一句话带过。
roundRobin   
这些应该写在 merge request 的 description 里面,而不是 commit message
netabare
OP
  
@roundRobin 对一个 PR 来说,这个 algorithm 可能只是其中一小部分,issue 里面提到的东西经常需要改蛮多东西的,而且产品那边也可能也会反复需求。
roundRobin   
@netabare 那这种情况一个 issue 应该分成多个 PR 来提交,每个做其中一部分功能,PR 的可读性,单元测试的可靠性都能增加,然后一起做个 e2e testing 。 我 review 的时候超过一页的 pr 都是直接 decline 让他 split 之后再提交
您需要登录后才可以回帖 登录 | 立即注册

返回顶部