Git提交模板需在项目根目录创建(如.gitmessage.txt),并通过git config --local commit.template ".gitmessage.txt"配置路径;PhpStorm仅在首次打开空提交框时自动填充模板,不支持图形化配置。

Git 提交模板在哪配,路径怎么写
PhpStorm 本身不提供图形化界面配置提交模板,它复用 Git 原生的 commit.template 配置项。你得手动指定一个纯文本文件(比如 .gitmessage.txt),然后用命令行把它写进当前项目的 Git 配置里。
操作步骤:
- 在项目根目录新建文件
.gitmessage.txt,内容示例:feat: 描述本次改动类型和目的 <ul><li>改动点1</li><li>改动点2</li></ul><h1>可选:关联 issue #123
- 打开终端,cd 到项目根目录,执行:
git config --local commit.template ".gitmessage.txt"
- 确认生效:运行
git config --local commit.template,应输出.gitmessage.txt
注意:--local 表示只对当前仓库生效;别用 --global,否则所有项目都套同一个模板,容易混。
PhpStorm 的 Commit 窗口里怎么触发模板
模板不会自动弹出,也不会覆盖你已输入的内容。它只在你**首次打开 Commit 窗口且未输入任何文字时**,作为默认占位符填充到编辑框里。
立即学习“PHP免费学习笔记(深入)”;
常见误区:
- 你已经打了几个字再点“刷新模板”,没用——PhpStorm 不会清空已有内容去套模板
- 你在 Settings → Version Control → Git 里找不到“模板”开关,因为压根没这个 UI 项
- 改了
.gitmessage.txt文件内容,但 Commit 窗口没更新?需要关掉再重开 Commit 工具窗口(Alt+0),或者重启 PhpStorm
模板内容怎么写才真正有用
空泛的“修复 bug”或“优化代码”起不到规范化作用。模板的核心是引导结构化表达,建议包含三部分:
-
首行前缀 + 冒号 + 简短描述(≤50 字):如
fix: login token 失效后未跳转登录页,方便后续生成 changelog 或过滤提交 - 空行分隔:Git 要求正文与标题之间必须有空行,否则正文会被忽略
-
正文用短横线列要点,可带 issue 引用:比如
- 校验 token 过期状态并重定向、- 补充单元测试覆盖异常流
别在模板里写死具体功能名或 PR 编号——那是每次提交要手动填的,模板只管格式骨架。
为什么改了模板却总被忽略
最常踩的坑是路径没写对,导致 Git 根本读不到文件:
- 配置里写的路径是相对
.git目录的,不是项目根目录。所以.gitmessage.txt必须放在和.git同级的位置(即项目根目录) - 路径含空格或中文?用英文引号包住,比如
git config --local commit.template "./.git message.txt" - 用的是 WSL 或远程开发?确保
.gitmessage.txt文件编码是 UTF-8 无 BOM,否则 PhpStorm 可能读成乱码甚至静默跳过 - 检查
.git/config文件里是否真有[commit] template = ".gitmessage.txt"这一行,没有就说明命令没执行成功
模板不是银弹——它只负责开头那几行,真正的规范靠团队约定和后续的 Git Hook(比如用 GrumPHP 检查首行格式)来兜底。 PhpStorm 提交窗口里那个小小的空白框,背后连着的是整个协作流程的起点。



















