手动为仓库创建单一议题模板
将手动创建的议题模板添加到仓库后,项目贡献者会自动在议题正文中看到模板的内容。
这是创建单议题模板的旧工作流程。我们建议使用升级的多议题模板生成器来创建多议题模板。更多信息请参阅“关于议题和拉取请求模板”。
您可以在任何支持的文件夹中创建 ISSUE_TEMPLATE/ 子目录,以包含多个议题模板,并且使用 template
查询参数指定填充议题正文的模板。 更多信息请参阅“关于使用查询参数自动化议题和拉取请求”。
添加议题模板
-
在 GitHub Enterprise 上,导航到仓库的主页面。
-
在文件列表上方,单击 Create new file(新建文件)。
-
在文件名字段中:
- 要使议题模板显示在仓库的根目录中,请输入 issue_template 的名称。 例如
issue_template.md
。 - 要使议题模板显示在仓库的
docs
目录中,请输入 docs/,后接issue_template 的名称。 例如docs/issue_template.md
。 - 要将文件存储在隐藏的目录中,请输入 .github/,后接 issue_template 的名称。 例如
.github/issue_template.md
。 - 要创建多个议题模板,并使用
template
查询参数指定填充议题正文的模板,请输入 .github/ISSUE_TEMPLATE/,后接议题模板的名称。 例如.github/ISSUE_TEMPLATE/issue_template.md
。 您也可以在根目录或docs/
目录的ISSUE_TEMPLATE
子目录中存储多个议题模板。 更多信息请参阅“关于使用查询参数自动化议题和拉取请求”。
- 要使议题模板显示在仓库的根目录中,请输入 issue_template 的名称。 例如
-
在新文件的正文中,添加您的议题模板。 这可能包括:
- 预期行为和实际行为。
- 重现问题的步骤。
- 规格,如项目版本、操作系统或硬件。
-
在页面底部,键入简短、有意义的提交消息,描述您对文件所做的更改。您可以在提交消息中将提交归因于多个作者。更多信息请参阅“创建多个合作作者的提交."
-
在 commit message(提交消息)字段下方,决定要将提交添加到当前分支还是添加到新分支。如果当前分支为
master
,则应选择为提交创建新分支,然后创建拉取请求。模板可供协作者用来合并到仓库的默认分支。 -
单击 Propose new file(提议新文件)。
延伸阅读
- "关于议题和拉取请求模板"
- "为仓库创建议题模板"
- "关于使用查询参数自动化议题和拉取请求"
- "创建议题"