我们对项目进行了大量更改,并将其提交到git存储库中,然后将这些更改与正确的提交消息一起提交。
在与许多协作者同时工作于更大的项目上进行协作时,提交消息应该是正确的,并反映出这些更改是什么。
许多大型项目都有标准的提交消息模板,协作者可以随时了解/了解这些更改。
现在,如果您尝试在git项目中提交任何更改而没有提供任何提交消息,则会使用vi编辑器或配置有默认提交模板的git编辑器弹出窗口,如下所示:
git commit
上面在配置的编辑器中打开以下模板-
Some awesome title
Why:
* ...
This change addresses the need by:
* ...
# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
# On branch master
# Changes to be committed:
# new file: README.md
现在,如果我们想更改为以下内容:
# Title:<here goes nice good short title, gives highlight of what changes are >
# Details : <More details on why for need of changes, >
# Issue no : <if it issue no. , an issue raised if any >
# Feature no : <Feature no. if working as Agile >
将以上模板或提交消息模板保存在任何文件中,但更喜欢将其保存在.gitmessage中,并按照以下命令运行-
git config --global commit.template <path-to-file>
例如
git config --global commit.template ~/.gitmessage
现在,如果您每次都执行git commit
,则以上模板将在已配置的编辑器中弹出,并允许您根据以上提交消息来适当地提交消息。
注意,在模板文件中,以“#”开头的行不会出现在最终提交中,因为它会被Git忽略。 因此,在上面的每个部分后面都用空行输入所需的内容:
上面的提交模板适用于所有项目,如果您想要每个项目的模板,请执行以下操作:
- 将目录更改为所需的git项目
- 运行以下命令(请注意,我们没有放置–global)
git config commit.template <path-to-template-file>
在这里,我们仅对此项目进行了项目特定的配置。 这只会为该项目放置提交模板。
每次执行git commit
,都会显示特定模板,而不是全局模板。
翻译自: https://www.javacodegeeks.com/2016/02/change-default-git-commit-message-template.html