Azure DevOps Server 拉取请求模板(Pull Request Template)

概述：

拉取请求(Pull Request)是Azure DevOps Server (之前称为TFS)系统中用于代码评审和分支合并的管理流程。使用拉取请求，代码评审人员可以记录记录代码评审过程中发现的问题、潜在的漏洞、创造性的亮点等。

在代码评审过程中，创建一个具有指导性的描述文档，可以帮助评审人员更好的了解评审过程中需要注意的事项，以便提高代码评审的效率和质量，提高评审人员和程序员之间的沟通效率。

在Azure DevOps Server 中，系统提供了一种自动生成拉取请求描述文档的机制。本文主要介绍如何使用拉取请求的模板功能实现自动生成描述文件(如下图)。

图一：拉取请求描述文档

拉取请求模板

拉取请求模板实际上是一个文本(.txt)或者markdown(.md)文件。当开发人员创建拉取请求的时候，Azure DevOps Server 会自动将这个文件的内容添加到拉取请求描述文字中，从而实现描述文档的标准话，并大幅提高拉取请求的创建速度。

例如下表中的内容是我们项目组定义的拉取请求标准文档，在后续的示例中，我们将为你介绍如何将这些Markdown文字添加到拉取请求中。

感谢您参与代码评审工作，请注意：

# 代码创建者需要：
- [ ] 确保代码通过了自动编译流水线，并没有任何错误和警告.
- [ ] 为新增的代码添加单元测试用例
- [ ] 在本地使用CodeCC和安全扫描工具时，确保通过所有质量控制门禁
#代码评审者需要：
- [ ] 在代码评审过程中，使用团队成员认可的专业术语
- [ ] 在代码评审过程中，对开发人员的亮点成果和存在的问题创建备注；
- [ ] 在代码评审完成后，对本次评审做出批准或拒绝的结论；

目前最新的Azure DevOps Server (2019.1.1)支持三种拉取请求模板：

1. 默认模板：在创建拉取请求过程中，系统会按照特定的规则，自动将默认模板内容添加到拉取请求中。
2. 分支模板：在创建拉取请求过程中，系统会为目标分支指定模板文件，并自动添加到拉取请求的的说明文档中。
3. 自选模板：在创建拉取请求过程中，用户可以自由选择拉取请求模板，并将其添加到拉取请求的的说明文档中。

无论是使用模板模板、分支模板，还是自选模板，实际上都取决于模板文档的存放位置和命名。模板文件和存放目录的名称不区分大小写，但是必须存放在默认分支中。

默认模板

默认模板文件中的内容会自动添加到拉取请求中，下面是默认模板的几个规则：

1. 存放分支：拉取请求模板文档必须保存在默认分支中
2. 文件命名：可以使用这两个文件命名，pull_request_template.md或pull_request_template.txt
3. 存放目录和顺序：可以存放在根目录中，也可以存放在这几个文件夹中，系统按照下面的顺序使用文档内容
4. 1. /.azuredevops/pull_request_template.md
   2. /.vsts/pull_request_template.md
   3. /docs/pull_request_template.md
   4. /pull_request_template.md

微软设计可以在多个文件夹中存放模板文件，主要是为了考虑文档的便捷性，并适应不同系统、不同开发团队的文档组织习惯。

如果我们已经在默认分支中创建了上面的拉取请求模板文件，但我们创建一个拉取请求的时候，系统会自动将文档中的内容添加到拉取请求描述文档中，如下图：

图二：模板文件存放在默认分支中

图三：系统自动添加拉取请求模板文件中的内容

分支模板

分支模板，是指只应用与特定目标分支的拉取请求模板文档。例如我们在创建一个拉取请求，目标分支dev，那么系统会自动将拉取请求文档dev.md中的内容添加到拉取请求描述文档中。

分支模板的同样需要存储在默认分支中，但是文档的命名规则和默认模板有区别。分支模板必须以目标分支的名称命名，例如dev.md、release.md、dev.txt等。

例如我们创建一个模板文件/pull_request_template/branches/release.md，当创建拉取请求的目标分支为release/*时(release目录下的分支)，系统自动将文件的内容添加到拉取请求中。如下图：

图四：分支模板的存放路径

图五：创建目标分支为release/V1.0.0.0的分支时，系统自动将release.md中的内容添加到拉取请求中

自选模板

我们按照上面的规则创建了拉取请求模板文档，Azure DevOps Server 会自动添加拉取请求模板文档中的内容。开发人员也可以在创建拉取请求时，自助选择使用哪个模板文件中的内容。

在拉取请求创建页面中，你可以点击“添加模板”按钮，并从下拉框中选择模板分支中的模板文件，并将其中的内容添加到说明文字中(如下图)

图六：自助选择拉取请求模板

------------------------------------------------------------

http://www.cnblogs.com/danzhang/  DevOps MVP 张洪君

------------------------------------------------------------