From fcb9a4a8a9cad1139943023faa981a2af762d570 Mon Sep 17 00:00:00 2001
From: Yao <chenyao1102@gmail.com>
Date: Mon, 9 Oct 2017 17:14:04 +0800
Subject: [PATCH] =?UTF-8?q?[new=20feature]=20Docs:=20waterfall=20=E6=96=87?=
 =?UTF-8?q?=E6=A1=A3=E4=BC=98=E5=8C=96=20(#175)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* doc: change waterfall docs

* change pr template
---
 .github/PULL_REQUEST_TEMPLATE.md      | 15 +++++++++++++++
 docs/examples-docs/zh-CN/waterfall.md | 14 ++++++++++++--
 docs/src/doc.config.js                |  4 ++++
 3 files changed, 31 insertions(+), 2 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 9ed032d1a..33f4ae89a 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -12,6 +12,21 @@
 
 ### 请认真写 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 组件
+
 ### Please remove the above lines when you submit this pull request, also please fill in the changes you've made in this pull request.
 
 ### 提交 PR 前 请把以上内容删除，并填写以下内容。
diff --git a/docs/examples-docs/zh-CN/waterfall.md b/docs/examples-docs/zh-CN/waterfall.md
index 00c2e406b..960de3ac7 100644
--- a/docs/examples-docs/zh-CN/waterfall.md
+++ b/docs/examples-docs/zh-CN/waterfall.md
@@ -31,6 +31,8 @@ export default {
 ### 代码演示
 
 <script>
+import { Waterfall } from 'packages';
+
 export default {
   data() {
     return {
@@ -39,9 +41,15 @@ export default {
       finished: false
     };
   },
+
+  directives: {
+    WaterfallLower: Waterfall('lower'),
+    WaterfallUpper: Waterfall('upper')
+  },
+
   methods: {
     loadMore() {
-      if (this.list.length >= 200) {
+      if (this.list.length >= 50) {
         this.finished = true;
         return;
       }
@@ -90,6 +98,8 @@ export default {
 
 #### 基础用法
 使用 `v-waterfall-lower` 监听滚动到达底部，并执行相应函数。若是函数执行中需要异步加载数据，可以将 `waterfall-disabled` 指定的值置为 false，禁止 `v-waterfall-lower` 监听滚动事件
+
+注意：`waterfall-disabled` 传入的是 vue 对象中表示是否禁止瀑布流触发 key 值，类型是字符串
 :::demo 基础用法
 ```html
 <p class="page-desc">当即将滚动到元素底部时，会自动加载更多</p>
@@ -108,6 +118,6 @@ export default {
 |-----------|-----------|-----------|-------------|-------------|
 | v-waterfall-lower | 滚动到底部, 触发执行的函数 | `Function`  | - |  |
 | v-waterfall-upper | 滚动到顶部, 触发执行的函数 | `Function`  | - |  |
-| waterfall-disabled | 在vue对象中表示是否禁止瀑布流触发的key值 | `String`  | - |  |
+| waterfall-disabled | 在 vue 对象中表示是否禁止瀑布流触发的 key 值 | `String`  | - |  |
 | waterfall-offset | 触发瀑布流加载的阈值 | `Number`  | `300` |   |
 
diff --git a/docs/src/doc.config.js b/docs/src/doc.config.js
index 27af62051..c6453e560 100644
--- a/docs/src/doc.config.js
+++ b/docs/src/doc.config.js
@@ -303,6 +303,10 @@ module.exports = {
               }
             ]
           },
+          {
+            "groupName": "Form",
+            "list": []
+          },
         ]
       }
     ]