在 Git 中,可以使用 git commit -m "commit message"
命令为提交添加注释。其中,-m
参数后面的字符串就是注释内容,也叫提交信息(commit message)。
注释通常包括了这次提交的变更内容、原因、影响等信息,以便其他开发者更好地了解这次提交的目的和意义。
在编写注释时,应该遵循一些规范,例如:
此外,还可以使用一些特殊的关键词来帮助更好地管理提交历史,例如:
fix
:修复了一个 bug。feat
:添加了一个新功能。docs
:仅对文档进行了修改。style
:修改了代码样式,如格式化、缩进等。refactor
:重构了代码,但未添加新功能或修复 bug。test
:添加或修改了测试代码。chore
:对构建过程或辅助工具进行了修改。这些关键词通常出现在注释的第一行,并用括号括起来,如 "feat: added feature X" 或 "fix: bug in feature Y".
综上所述,为 Git 提交添加注释的步骤如下:
git add
命令将修改的文件添加到暂存区(stage)。git commit -m "commit message"
命令提交变更,并添加注释。注释应该遵循一定的规范,并使用关键词来帮助更好地管理提交历史。