Description templates

原文：https://docs.gitlab.com/ee/user/project/description_templates.html

Description templates

在 GitLab 8.11 中引入 .

我们都知道，项目开发人员更有可能及时解决提交的问题.

使用描述模板，您可以为问题定义特定于上下文的模板，并为项目合并请求描述字段，并帮助从问题中过滤掉许多不必要的噪音.

Overview

通过使用描述模板，创建新发行或合并请求的用户可以选择描述模板，以帮助他们与其他贡献者进行有效沟通.

每个 GitLab 项目都可以定义自己的一组描述模板，这些模板将被添加到 GitLab 项目存储库的根目录中.

描述模板必须用Markdown编写，并存储在项目的存储库中的.gitlab目录下. 仅考虑默认分支的模板.

Use-cases

  • 添加一个模板，该模板将用于特定项目的每个问题，并提供说明和指南，要求提供特定于该主题的信息. 例如，如果您有一个用于跟踪新博客文章的项目，则可以要求标题，大纲，作者姓名，作者社交媒体信息等等.
  • 在前面的示例之后，您可以为随新博客帖子提交的每个 MR 创建模板，要求提供有关帖子日期，前事数据，图像准则，相关问题的链接，审阅者姓名等信息.
  • 您还可以为工作流的不同阶段创建问题并合并请求模板，例如功能建议，功能改进或错误报告.

Creating issue templates

在存储库的.gitlab/issue_templates/目录内创建一个新的 Markdown（ .md ）文件. 提交并推送到您的默认分支.

To create a Markdown file:

  1. 单击master旁边的+按钮，然后单击New file .
  2. 将问题模板的名称添加到master旁边的File name文本字段中. 确保单词之间用下划线分隔，并且文件的扩展名为.md ，例如feature_request.md .
  3. 提交并推送到您的默认分支.

如果您的存储库中没有.gitlab/issue_templates目录，则需要创建它.

要创建.gitlab/issue_templates目录：

  1. 单击master旁边的+按钮，然后选择New directory .
  2. 将此新目录.gitlab并提交到默认分支.
  3. 再次单击master旁边的+按钮，然后选择New directory .这次，n
  4. 将目录issue_templates并提交到默认分支.

要检查它是否正常工作，请创建一个新问题，然后查看是否可以选择描述模板.

Creating merge request templates

与发布模板类似，在存储库的.gitlab/merge_request_templates/目录内创建一个新的 Markdown（ .md ）文件. 提交并推送到您的默认分支.

Using the templates

让我们以创建了.gitlab/issue_templates/Bug.md文件.gitlab/issue_templates/Bug.md . 在创建或编辑问题时，这将启用Bug下拉选项. 选择Bug ， Bug.md模板文件中的内容将被复制到问题描述字段. “重置模板”按钮将放弃您在选择模板后所做的任何更改，并将其恢复为初始状态.

Description templates

Setting a default template for merge requests and issues

版本历史

在项目的“设置” /“可见性”，”项目功能”，”权限”部分中，应将问题和/或合并请求的可见性设置为”每个人都可以访问”或”只有项目成员”，否则模板文本区域将不会显示. 这是默认行为，因此在大多数情况下都可以.

  1. 转到项目的“设置” .
  2. 单击合并请求标题下的展开 .
  3. 填写” 合并请求的默认描述模板”文本区域.
  4. Click Expand under 默认问题模板.
  5. 填写问题的默认描述模板文本区域. 由于 GitLab 合并请求和问题支持Markdown ，因此您可以使用它来格式化标题，列表等.

Default merge request description templates

Default issue description templates

添加描述后，点击保存更改以使设置生效. 现在，每次创建新的合并请求或问题时，都将使用您在模板中输入的文本预先填充.

Description template example

我们在 GitLab 社区版项目中使用问题和合并请求的描述模板. 请参考.gitlab文件夹中的一些示例.

提示：可以在描述模板中使用快速操作来快速添加标签，受让人和里程碑. 仅当提交问题或合并请求的用户有权执行相关操作时，才执行快速操作.

这是错误报告模板的示例：

  1. Summary
  3. (Summarize the bug encountered concisely)
  5. Steps to reproduce
  7. (How one can reproduce the issue - this is very important)
  9. Example Project
  11. (If possible, please create an example project here on GitLab.com that exhibits the problematic behaviour, and link to it here in the bug report)
  13. (If you are using an older version of GitLab, this will also determine whether the bug has been fixed in a more recent version)
  15. What is the current bug behavior?
  17. (What actually happens)
  19. What is the expected correct behavior?
  21. (What you should see instead)
  23. Relevant logs and/or screenshots
  25. (Paste any relevant logs - please use code blocks (```) to format console output,
  26. logs, and code as it's very hard to read otherwise.)
  28. Possible fixes
  30. (If you can, link to the line of code that might be responsible for the problem)
  32. /label ~bug ~reproduced ~needs-investigation
  33. /cc @project-manager
  34. /assign @qa-tester