帮助文档
Pull Requests
PR 模版

PullRequest 模板

创建一个GitCode Pull Request (PR) 模板可以帮助贡献者提供符合项目需求的高质量的 Pull Request。这个模板可以指导贡献者提供所有必要的信息，以便项目维护者更有效地审查和合并代码。以下是创建和使用 GitCode Pull Request 模板的指南。

创建 Pull Request 模板

  1. 选择模板位置: 你可以将 PR 模板放在项目的根目录下的 .gitcode/ 文件夹中，或者在 docs/ 或 .gitcode/PULL_REQUEST_TEMPLATE/ 文件夹中创建一个 PULL_REQUEST_TEMPLATE.md 文件。如果你在 .gitcode/PULL_REQUEST_TEMPLATE/ 文件夹中创建多个模板文件，GitCode 将在创建 PR 时提供这些模板的列表供贡献者选择。
  2. 编写模板内容: 在 PULL_REQUEST_TEMPLATE.md 文件中编写模板的内容。你可以包括一些基本的头部信息，问题描述，变更类型，测试说明，以及任何额外的备注或说明。确保提示贡献者提供所有你认为对审查有帮助的信息。你可以在新建的 .md文件中配置 front-matter 信息，包括 PR 模板的标题、指定合并人、指定 Label 等。同时在新建的 .md 文件中添加正文内容，该内容会作为用户新建 PR 时预设的内容填充到描述中。
  3. 使用模板: 一旦你创建了模板，当贡献者创建 Pull Request 时，GitCode 会自动将你的模板内容填充到 PR 描述框中。贡献者应该根据模板的提示填写所有相关信息。

示例模板

---
title: "【PR模版】:"
labels: ["fix bug"]
assignees: 'username'
---

# Pull Request 模板

## 描述
请提供此 Pull Request 的高级别说明。

## 类型
- [ ] Bug 修复
- [ ] 新功能
- [ ] 代码风格更新（格式化，局部变量）
- [ ] 重构（即不是新增功能，也不是修改bug的代码变动）
- [ ] 构建过程或辅助工具的变动
- [ ] 文档内容更新

## 如何测试
描述测试这个变更的步骤，包括哪些文件需要被修改。

## Checklist:
- [ ] 我的代码遵循这个项目的代码风格
- [ ] 我已经自己测试过我的代码
- [ ] 我已经更新了相应的文档
- [ ] 我已经根据需要更新了对应的变更日志
- [ ] 我已经在标题中正确使用了类型标签（例如：`feat:`, `fix:`）

## 其他信息
在这里可以添加任何与这个 Pull Request 相关的其他说明。

Front-matter 介绍

目前我们支持以下几种 markdown 的 front-matter 配置：

字段 说明 备注
titile PR 预设标题 含中文使用双引号
labels PR 的 labels，支持多个 多个需要使用中括号，当含有不存在的 labels 时，在创建 PR 时不显示该 label
assignees PR 默认指派的合并人 指派合并人的 username

注意事项

  • 清晰明了: 确保你的模板简洁明了，这样贡献者可以轻易地理解和遵循。
  • 灵活性: 鼓励贡献者遵循模板，但也应该允许一定程度的灵活性。不是所有的部分都必须由每一个贡献者填写。
  • 更新维护: 随着项目的发展，定期更新你的模板以确保它们仍然相关并且能够帮助你达到项目的目标。

通过提供清晰、有组织的 Pull Request 模板，你可以提高项目的质量，加快 PR 审查流程，并帮助贡献者更有效地参与到项目中来。