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 注意事项

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,539评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,911评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,337评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,723评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,795评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,762评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,742评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,508评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,954评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,247评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,404评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,104评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,736评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,352评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,557评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,371评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,292评论 2 352

推荐阅读更多精彩内容

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