docs: update README badges & contributing (#85)

Author: donaldshen

.github/badge.yml

@@ -1,11 +1,12 @@
 types:
   feat: 'enhancement'
-  fix: 
+  fix:
     hack: 'hack'
     default: 'bug'
   hack: 'hack'
   docs: 'documentation'
   refactor: 'refactor'
+  style: 'style'
   test: 'test'
   perf: 'performance'
   chore:

.grenrc.js

@@ -26,6 +26,7 @@ module.exports = {
     '🚀 Performance:': ['performance'],
     '⚓ Dependency upgrades:': ['dependencies'],
     '🏡 Chore:': ['chore'],
+    '💄 Style:': ['style'],
     '🎩 Hack': ['hack']
   }
 }

README-zh.md

@@ -1,15 +1,15 @@
 # el-form-renderer
 
-[![Build Status](https://travis-ci.com/FEMessage/el-form-renderer.svg?branch=master)](https://travis-ci.com/FEMessage/el-form-renderer)
-[![NPM Download](https://img.shields.io/npm/dm/@femessage/el-form-renderer.svg)](https://www.npmjs.com/package/@femessage/el-form-renderer)
-[![NPM Version](https://img.shields.io/npm/v/@femessage/el-form-renderer.svg)](https://www.npmjs.com/package/@femessage/el-form-renderer)
-[![NPM License](https://img.shields.io/npm/l/@femessage/el-form-renderer.svg)](https://github.com/FEMessage/el-form-renderer/blob/master/LICENSE)
+[![Build Status](https://badgen.net/travis/FEMessage/el-form-renderer/master)](https://travis-ci.com/FEMessage/el-form-renderer)
+[![NPM Download](https://badgen.net/npm/dm/@femessage/el-form-renderer)](https://www.npmjs.com/package/@femessage/el-form-renderer)
+[![NPM Version](https://badgen.net/npm/v/@femessage/el-form-renderer)](https://www.npmjs.com/package/@femessage/el-form-renderer)
+[![NPM License](https://badgen.net/npm/license/@femessage/el-form-renderer)](https://github.com/FEMessage/el-form-renderer/blob/master/LICENSE)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/FEMessage/el-form-renderer/pulls)
 [![Automated Release Notes by gren](https://img.shields.io/badge/%F0%9F%A4%96-release%20notes-00B2EE.svg)](https://github-tools.github.io/github-release-notes/)
 
 ![](https://cdn.nlark.com/yuque/0/2019/png/160590/1563849166655-0c7319bc-37f1-4ddd-94ff-13051bdd6691.png)
 
-## Table of Contents <!-- omit in toc -->
+## Table of Contents
 
 * [Introduction](#introduction)
   * [内部集成](#内部集成)
@@ -18,8 +18,9 @@
 * [Links](#links)
 * [Quick Start](#quick-start)
 * [Inspiration](#inspiration)
-* [License](#license)
+* [Contributing](#contributing)
 * [Contributors](#contributors)
+* [License](#license)
 
 ## Introduction
 
@@ -55,15 +56,16 @@ el-data-table、el-data-tree 等组件内部集成该组件，用于更加灵活
 * 支持渲染自定义组件
 * 支持自定义组件设置校验规则
 
-**[⬆ Back to Top](#table-of-contents)**
+[⬆ Back to Top](#table-of-contents)
 
 ## Links
 
 * [api doc and online demo](https://femessage.github.io/el-form-renderer/)
 * [自定义组件接入指南](https://github.com/femessage/el-form-renderer/blob/master/docs/guide-custom-component.md)
 * [自定义组件设置校验规则](https://github.com/FEMessage/el-form-renderer/blob/master/docs/guide-custom-rules-in-custom-component.md)
+* [fem-vscode-helper](https://marketplace.visualstudio.com/items?itemName=FEMessage.fem-vscode-helper)
 
-**[⬆ Back to Top](#table-of-contents)**
+[⬆ Back to Top](#table-of-contents)
 
 ## Quick Start
 
@@ -93,17 +95,24 @@ export default {
 </script>
 ```
 
-**[⬆ Back to Top](#table-of-contents)**
+[⬆ Back to Top](#table-of-contents)
 
 ## Inspiration
 
 thanks to [element-patch](https://github.com/leezng/element-patch)
 
-## License
+## Contributing
 
-[MIT](./LICENSE)
+For those who are interested in contributing to this project, such as:
+
+- report a bug
+- request new feature
+- fix a bug
+- implement a new feature
+
+Please refer to our [contributing guide](https://github.com/FEMessage/.github/blob/master/CONTRIBUTING.md).
 
-**[⬆ Back to Top](#table-of-contents)**
+[⬆ Back to Top](#table-of-contents)
 
 ## Contributors
 
@@ -125,3 +134,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+## License
+
+[MIT](./LICENSE)
+
+[⬆ Back to Top](#table-of-contents)

README.md

@@ -1,33 +1,36 @@
 # el-form-renderer
 
-[![Build Status](https://travis-ci.com/FEMessage/el-form-renderer.svg?branch=master)](https://travis-ci.com/FEMessage/el-form-renderer)
-[![NPM Download](https://img.shields.io/npm/dm/@femessage/el-form-renderer.svg)](https://www.npmjs.com/package/@femessage/el-form-renderer)
-[![NPM Version](https://img.shields.io/npm/v/@femessage/el-form-renderer.svg)](https://www.npmjs.com/package/@femessage/el-form-renderer)
-[![NPM License](https://img.shields.io/npm/l/@femessage/el-form-renderer.svg)](https://github.com/FEMessage/el-form-renderer/blob/master/LICENSE)
+[![Build Status](https://badgen.net/travis/FEMessage/el-form-renderer/master)](https://travis-ci.com/FEMessage/el-form-renderer)
+[![NPM Download](https://badgen.net/npm/dm/@femessage/el-form-renderer)](https://www.npmjs.com/package/@femessage/el-form-renderer)
+[![NPM Version](https://badgen.net/npm/v/@femessage/el-form-renderer)](https://www.npmjs.com/package/@femessage/el-form-renderer)
+[![NPM License](https://badgen.net/npm/license/@femessage/el-form-renderer)](https://github.com/FEMessage/el-form-renderer/blob/master/LICENSE)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/FEMessage/el-form-renderer/pulls)
 [![Automated Release Notes by gren](https://img.shields.io/badge/%F0%9F%A4%96-release%20notes-00B2EE.svg)](https://github-tools.github.io/github-release-notes/)
 
 ![](https://cdn.nlark.com/yuque/0/2019/png/237102/1564392138773-3b4a3555-9ce5-4825-8510-53ae092711f6.png)
 
 [中文文档](./README-zh.md)
 
-## Table of Contents <!-- omit in toc -->
+## Table of Contents
 
 * [Introduction](#introduction)
+  * [WHAT](#what)
+  * [WHY](#why)
 * [Features](#features)
 * [Links](#links)
 * [Quick Start](#quick-start)
 * [Inspiration](#inspiration)
-* [License](#license)
+* [Contributing](#contributing)
 * [Contributors](#contributors)
+* [License](#license)
 
 ## Introduction
 
-**WHAT**
+### WHAT
 
 `el-form-renderer` is based on [element-ui](https://github.com/ElemeFE/element), but not limited [element-ui](https://github.com/ElemeFE/element) components. On the basis of completely inheriting the form attribute of element-ui, extension is made. Some non-form components or custom components, such as picture uploading and rich text editor, can also be integrated, thus, users can render a complete form by using a piece of json.
 
-**WHY**
+### WHY
 
 In our daily development, there are lots page with form, and usually the form structure is similar, the logic is repeated. el-form-renderer does not have complicated logic. It only convert JSON to render form item, save time and energy to write business logic, and reduce duplicate code.
 
@@ -39,15 +42,16 @@ In our daily development, there are lots page with form, and usually the form st
 * Support setOptions method, dynamically change select options
 * Content support `inputFormat` , `outputFormat` , `trim` to process component's input and output values
 
-**[⬆Back to Top](#table-of-contents)**
+[⬆Back to Top](#table-of-contents)
 
 ## Links
 
 * [Docs](https://femessage.github.io/el-form-renderer/)
 * [Guide to developing custom component](https://github.com/femessage/el-form-renderer/blob/dev/docs/guide-en-custom-component.md)
 * [Setting validation rules in custom component](https://github.com/FEMessage/el-form-renderer/blob/dev/docs/guide-en-custom-rules-in-custom-component.md)
+* [fem-vscode-helper](https://marketplace.visualstudio.com/items?itemName=FEMessage.fem-vscode-helper)
 
-**[⬆Back to Top](#table-of-contents)**
+[⬆Back to Top](#table-of-contents)
 
 ## Quick Start
 
@@ -74,17 +78,24 @@ export default {
 </script>
 ```
 
-**[⬆Back to Top](#table-of-contents)**
+[⬆Back to Top](#table-of-contents)
 
 ## Inspiration
 
 thanks to [element-patch](https://github.com/leezng/element-patch)
 
-## License
+## Contributing
 
-[MIT](./LICENSE)
+For those who are interested in contributing to this project, such as:
+
+- report a bug
+- request new feature
+- fix a bug
+- implement a new feature
+
+Please refer to our [contributing guide](https://github.com/FEMessage/.github/blob/master/CONTRIBUTING.md).
 
-**[⬆ Back to Top](#table-of-contents)**
+[⬆ Back to Top](#table-of-contents)
 
 ## Contributors
 
@@ -106,3 +117,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+## License
+
+[MIT](./LICENSE)
+
+[⬆ Back to Top](#table-of-contents)

package.json

@@ -8,21 +8,9 @@
     "type": "git",
     "url": "https://github.com/FEMessage/el-form-renderer.git"
   },
-  "contributors": [
-    "https://github.com/FEMessage"
-  ],
-  "keywords": [
-    "vue",
-    "element",
-    "render",
-    "form",
-    "component"
-  ],
-  "files": [
-    "src",
-    "dist",
-    "yarn.lock"
-  ],
+  "contributors": ["https://github.com/FEMessage"],
+  "keywords": ["vue", "element", "render", "form", "component"],
+  "files": ["src", "dist"],
   "main": "dist/el-form-renderer.umd.js",
   "module": "dist/el-form-renderer.esm.js",
   "unpkg": "dist/el-form-renderer.min.js",
@@ -32,13 +20,17 @@
   "scripts": {
     "dev": "vue-styleguidist server",
     "doc": "vue-styleguidist build",
-    "build": "npm run build:unpkg & npm run build:es & npm run build:umd & npm run doc",
-    "build:umd": "rollup --config build/rollup.config.js --format umd --file dist/el-form-renderer.umd.js",
-    "build:es": "rollup --config build/rollup.config.js --format es --file dist/el-form-renderer.esm.js",
-    "build:unpkg": "rollup --config build/rollup.config.js --format iife --file dist/el-form-renderer.min.js",
+    "build":
+      "npm run build:unpkg & npm run build:es & npm run build:umd & npm run doc",
+    "build:umd":
+      "rollup --config build/rollup.config.js --format umd --file dist/el-form-renderer.umd.js",
+    "build:es":
+      "rollup --config build/rollup.config.js --format es --file dist/el-form-renderer.esm.js",
+    "build:unpkg":
+      "rollup --config build/rollup.config.js --format iife --file dist/el-form-renderer.min.js",
     "stdver": "standard-version -m '[skip ci] chore(release): v%s'",
     "release": "gren release --override",
-    "test": "jest"
+    "test": "jest --verbose"
   },
   "homepage": "https://github.com/FEMessage/el-form-renderer",
   "dependencies": {
@@ -84,27 +76,16 @@
     "node": ">= 4.0.0",
     "npm": ">= 3.0.0"
   },
-  "vue-sfc-cli": "1.10.4",
-  "browserslist": [
-    "> 1%",
-    "last 2 versions",
-    "not ie <= 8"
-  ],
+  "vue-sfc-cli": "1.10.6",
+  "browserslist": ["> 1%", "last 2 versions", "not ie <= 8"],
   "husky": {
     "hooks": {
       "pre-commit": "lint-staged",
       "post-commit": "git update-index --again"
     }
   },
   "lint-staged": {
-    "*.(js|md)": [
-      "prettier --write",
-      "git add"
-    ],
-    "*.vue": [
-      "prettier --write",
-      "stylelint --fix",
-      "git add"
-    ]
+    "*.(js|md)": ["prettier --write", "git add"],
+    "*.vue": ["prettier --write", "stylelint --fix", "git add"]
   }
 }