GitHub中使用 issues 模版和 pull request 模版

摘要:在GitHub代码库中,引入代码库维护者定制的 issues 模版和 pull request 模版,让人们可以有针对性的提供某类问题的准确信息,从而在后续维护中能够进行有效地对话和改进,而不是杂乱无章的留言。

一、issues 模版

1.1 默认模版

  • 在代码库新建目录:.github
  • .github 目录下添加 ISSUE_TEMPLATE.md 文件作为 issues 默认模版。当创建 issue 时,若未建立多模版或选择了 Open a regular issue 时,系统会引用该模版。
引用默认模版

1.2 多模版

  • 在代码库新建目录:.github/ISSUE_TEMPLATE
  • 该目录下可添加多个 .md 文件作为 issues 模版。当创建 issue 时,系统会展示这些模版供选择。
  • .md 文件参考格式如下:
---
name: 该模版的名称(创建 issue 时,系统展示模版列表时会显示该名称)
about: 该模版的描述(创建 issue 时,系统展示模版列表时会显示该描述)
---

正文内容……

1.3 注意事项

二、pull request 模版

2.1 默认模版

  • 在代码库新建目录:.github
  • .github 目录下添加 PULL_REQUEST_TEMPLATE.md 文件作为 pull request 默认模版。当创建不带参数的 pull request 时,系统会引用该模版。

2.2 多模版

  • 在代码库新建目录:.github/PULL_REQUEST_TEMPLATE
  • 该目录下可添加多个 .md 文件作为 pull request 模版。
  • pull request 模版要通过查询参数来调用。例如,要使用 pr-template-1.md 这个模版,可使用如下查询:
https://github.com/用户名/代码库名称/compare/分支名称?expand=1&template=pr-template-1.md
或参考GitHub帮助文档的格式,如下。两者效果相同。
https://github.com/用户名/代码库名称/compare/master...分支名称?expand=1&template=pr-template-1.md
  • 可选查询参数

2.3 注意事项

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 前言 此文旨在为iOS app开发者提供最全的常用安全防护手段。涉及到如字符串加密,类名以及方法名混淆,程序结构混...
    偏北风23级阅读 4,079评论 0 1
  • 就这样写写画画, 不要停下来, 该多好, 思想集中在字与画里, 享受着写字和画画带来的美好, 就会想不起那些……
    禧珍阅读 1,846评论 2 6
  • 我如果是我?谁都是我!我又是谁呢? 我如不是我,你不是你,谁又是谁呢? 我爱的你不过是我爱的我。 我厌的谁不过是我...
    善良的老虎阅读 1,378评论 0 0