为啥微信的更新信息大多数都是:修复已知问题,但是开发中不建议这样。
背景
可能大家平常有意或无意的注意到,微信的更新日志经常是:解决了一些已知问题。
但是开发人员日常开发中,提交的信息一般会避免这样,反而会要求把提交信息写的比较详细。
原因
首先,从用户体验的角度来看,频繁地列出所有已知问题及其修复情况可能会让用户感到困惑或担忧,尤其是当这些问题涉及到隐私、安全等敏感话题时。其次,微信作为一个庞大的社交平台,其功能众多,更新日志如果详细到每一项改动,不仅对普通用户来说难以理解,也会增加开发团队的工作量。此外,微信的更新往往伴随着大量的内部优化和结构调整,这些内容对于普通用户而言并不重要,也不易被察觉。
而对于开发人员来说,commit信息一是给自己以后看,通过提交信息就可以知道自己修改了哪些内容,其二就是给其他开发人员查看,从而知道别人修改了哪些地方。
查看提交日志
那么关于微信相关的我们不再赘述,主要针对开发人员的提交信息进行一些讨论,比如如何查看提交信息呢,在idea中可以直接查看git log,也可以通过命令git log
来进行查看,或者也可以使用命令git show commitHash
针对每一个提交信息进行详细的查看,例如:
$ git show 32557725d91403ca8e5ae520a5f82a516791f5c0
commit 32557725d91403ca8e5ae520a5f82a516791f5c0
Author: test1 <test1@some.com>
Date: Wed Mar 20 16:53:56 2024 +0800
b5 commit
diff --git a/b.txt b/b.txt
index 86bd041..be62feb 100644
--- a/b.txt
+++ b/b.txt
@@ -2,4 +2,6 @@
22222
33333
-44444
\ No newline at end of file
+44444
+
+55555
\ No newline at end of file
本人代码提交方式
关于代码提交规范,相关的文章有很多,我在此先不多说,只是把我平常所用到的描述一下,大家可以参考。
针对每次的功能涉及到几个方面:代码优化,新功能开发,bug修复等。
- 针对新功能开发:一般是
git commit xxxx.java -m 'feat:用户登录限制只允许特定IP地址来登录管理员账号'
- 针对bug修复:一般是
git commit xxx.java -m 'fix:用户登录后看不到自己的工作任务'
针对 - 针对代码优化:,则是
git commit xxx.sql -m 'refactor:把原来不存在的用户显示为ID账号,而非null'
总结
其实写好commit信息有较多好处,不单单是上面提到的个人追溯问题容易以及同事协作简单。以下我列出来我想到的。
- 通过commit信息方便自己进行日报周报的总结
- 方便进行某些问题的回退
- 方便快速的梳理功能,以便于线上环境的验证
- 有益于自己代码的精简提交,如果多个文件一起提,那么commit信息可能就会更复杂
致谢
以上就是从微信的一个更新日志,进而针对开发人员的commit信息进行了一些简单阐述。感谢你的耐心阅读,如果我的分享对你有所启发或帮助,就给个赞呗,很开心能帮到别人。
作者:bramble
来源:juejin.cn/post/7351726029322928155
来源:juejin.cn/post/7351726029322928155