Git提交代码前必做:检查修改、暂存与提交信息
### Git提交代码前的“黄金三步” 提交代码前需确认修改内容,避免误提交敏感信息或未完成代码。核心步骤如下: **1. 检查修改**:用 `git status` 查看项目状态,区分“已修改未暂存”和“未跟踪文件”;用 `git diff <file>` 查看具体修改内容(如新增/删除行),避免提交临时注释、调试日志等无关内容。 **2. 暂存修改**:用 `git add` 将待提交文件暂存。单个文件用 `git add <file>`,全部修改用 `git add .`(需谨慎,避免误加无关文件);若暂存错误,用 `git reset HEAD <file>` 撤回。 **3. 写清提交信息**:用 `git commit` 提交前,需清晰描述修改目的。简短信息用 `-m "描述"`(如“优化首页标题”),复杂内容可打开文本编辑器(默认Vim)写多行,确保信息简洁且有意义。 养成“检查-暂存-写信息”的习惯,可避免错误提交,提升团队协作效率。
阅读全文Git提交信息规范:为什么要写清晰的commit message?
你是否遇到过Git提交记录模糊(如“改了”“修复bug”),回顾修改细节困难?清晰的commit message能解决这类问题。它是代码变更的“日记”,需说明“做了什么”“为什么做”。 写规范commit message有四大好处:快速回忆(半年后也能看懂修改)、团队协作(成员快速定位功能变更)、自动化工具支持(生成版本日志、自动升级版本号)、快速定位bug(线上问题时用git bisect快速缩小范围)。 规范建议从简单开始:至少包含“类型+描述”,常见类型有fix(修复bug)、feat(新增功能)等;进阶可选Conventional Commits规范,格式为<类型>[可选作用域]: <描述>,可带正文和脚注。新手可先从“类型+描述”入手,用cz-cli等工具辅助,每次提交前花10秒明确核心内容,坚持即可提升代码管理效率。
阅读全文