这是一篇示例文章,用于展示博客的阅读体验。
说清楚改变了什么
“修改了一些问题”很难在以后帮助我们理解代码。一条好的提交标题,可以直接说清楚具体行为,例如“保留读者选择的深色主题”。
标题不需要塞进所有细节。它的任务是让浏览记录的人,快速判断这次改动与自己的问题有没有关系。
补上为什么
当修改的原因无法从代码中直接看出来,正文就有价值了。记录具体触发条件、原来的表现和改动后的表现,会比复述每个函数名更有帮助。
保留读者选择的深色主题
原先每次刷新都重新使用系统主题,导致主动选择丢失。
现在优先读取本地设置;没有设置时再跟随系统偏好。让一次提交有一个主题
如果一次提交同时包含主题切换、导航重排和无关的文件整理,后来查问题或撤销修改就会变得困难。尽量按完整的行为拆分,而不是按文件类型拆分。
提交前看一遍差异,确认没有把临时日志和无关内容带进去。几分钟的整理,可以省下未来很长的一次排查。
感谢阅读,愿你也拥有值得记录的一天。
