From 08ba48621a3bb79a34114cd8cbc3dcbb879d42fe Mon Sep 17 00:00:00 2001 From: pangxie1991 Date: Sun, 15 Oct 2017 21:57:11 +0800 Subject: [PATCH] add issue && pr template --- .github/ISSUE_TEMPLATE.md | 5 +++++ .github/PULL_REQUEST_TEMPLATE.md | 27 +++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..7743f8e4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,5 @@ +### 请认真写 ISSUE 的标题,会用于生成 change log。 + +**请确认是需要 *新增功能* 还是 *提交bug* ** + +** 如果是 bug,请提供复现步骤,可能的话,可以在 [https://jsfiddle.net](https://jsfiddle.net) 或者类似平台上提供一个 demo ** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..24822d2a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ +### 提交 PR 前请确保完成以下内容: + +### 认真写 PR 的标题,会用于生成 change log。 + +#### 标题规则 +[bug fix / breaking change / new feature] 组件名字:修改内容描述 + +说明: +* 前面方括号用来区分 Issue / PR 的 类型:bug fix - 改 bug;breaking change: 不兼容的改动;new feature:新功能 +* 修改内容尽可能言简意赅,总结 PR 的改动或者描述 Issue +* 描述请用中文 +* 组件名字请用英文,首字母大写 + +示例: +* [bug fix] Button: 修改颜色 +* [breaking change] Loading: 删除 `static` 属性 +* [new feature] Form: 增加 `FormSelection` 支持 +* [new feature] 新增 Abc 组件 + +### 提交 PR 前 请把以上内容删除,并填写以下内容。 + +修复 #xx(issue 编号), 如果没有相关 issue, 请移除这行。 + +pull request 改动点: + +- 改动一 +- 改动二