create release of 4.4.0

.github/stale.yml

@@ -13,6 +13,7 @@ onlyLabels: []
 # Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
 exemptLabels:
   - "maybe-later"
+  - "priority: high"
 
 # Set to true to ignore issues in a project (defaults to false)
 exemptProjects: true
@@ -33,8 +34,8 @@ markComment: >
   for your contributions.
 
 # Comment to post when removing the stale label.
-# unmarkComment: >
-#   Your comment here.
+unmarkComment: >
+  This issue is marked to be `stale` and is going to be closed within a week. If you think it shouldn't be closed, please leave a comment.
 
 # Comment to post when closing a stale Issue or Pull Request.
 # closeComment: >

.github/CONTRIBUTING.md → CONTRIBUTING.md

@@ -14,17 +14,45 @@ Please read the [documentation](http://echarts.apache.org/option.html) carefully
 
 Any questions in the form of *how can I use echarts to* or *how to use echarts x feature to* belong in [Stack Overflow](http://stackoverflow.com), issues with questions like that in the issue tracker will be closed.
 
+## Release Milestone Discussion
+
+We will start the discussion about the bugs to fix and features of each release in the [mailing list](https://echarts.apache.org/en/maillist.html). You may subscribe our [mailing list](https://echarts.apache.org/en/maillist.html) to give your valuable advice in the milestone dicussion.
+
+About our release plan, we will release a mior version at the end of every month. Here is some detail.
+
+1. Assume our current stable release is 4.3.0. We will start the discussion of milestone of the release two versions ahead, which is 4.5.0 at the beginning of each month. At this time we should also kickoff the developing of the next release, which is 4.4.0.
+2. Finish 4.4.0 developing at about 22th of this month and start the testing. And the 4.5.0 milestone discussion is frozen and published on the [GitHub](https://github.com/apache/incubator-echarts/milestone/14)
+3. Vote in the mailing list for the 4.4.0 release at the end of this month.
+
 ## Pull Requests
 
-If you wish to fix a bug or add new features, please discuss it with us in an issue first. If there's no issue, please create one using the [echarts issue helper](https://ecomfe.github.io/echarts-issue-helper/).
+### Finding Easy Issues to Fix
+
+You may use [difficulty: easy](https://github.com/apache/incubator-echarts/labels/difficulty%3A%20easy) label to filter issues that we think is easier to fix. These are issues that should be fixed using less time than the average. So if you wish to make some pull requests, this is where you can start with.
+
+You may also filter with [en](https://github.com/apache/incubator-echarts/issues?q=is%3Aopen+label%3A%22difficulty%3A+easy%22+label%3Aen) label for English issues only.
+
+### Coding Standard
+
+Please follow the [coding standard](https://echarts.apache.org/en/coding-standard.html) before you make any changes.
+
+### Git Message Standard
+
+(TBD)
+
+### Contact Us
+
+If you wish to fix a bug or add new features but don't know how, please discuss it with us in the [mailing list](dev@echarts.apache.org).
+
 
 ## How to Debug ECharts
 
 The following steps help you to set up a developing environment for ECharts.
 
+
 ### 1. Clone ECharts project
 
-If you wish to make pull requests, you should fork the ECharts project first. Otherwise, just clone it locally.
+If you wish to make pull requests, you should **fork the ECharts project** first. Otherwise, just clone it locally.
 
 ```bash
 git clone git@github.com:apache/incubator-echarts.git
@@ -38,6 +66,7 @@ git clone git@github.com:ecomfe/zrender.git
 
 We assume these projects are downloaded at `~/workspace/echarts` and `~/workspace/zrender`. But their locations can be arbitrary.
 
+
 ### 2. Install dependencies
 
 ```bash
@@ -53,11 +82,12 @@ Sometimes, in order to fix an issue within echarts, changes have to be made insi
 cd ~/workspace/zrender
 npm link
 cd ~/workspace/echarts
-npm link
+npm link zrender
 ```
 
 With this, you can see that `~/workspace/echarts/node_modules/zrender` is a link to `~/workspace/zrender`.
 
+
 ### 3. Run and debug
 
 To build the ECharts project and watch source file changes (including ZRender project) to rebuild:
@@ -75,9 +105,84 @@ node build/build.js
 
 Then, open the test cases under `~/workspace/echarts/test` in Web browser. You can add breakpoints under `src` directory. For example, in Chrome Inspect, it looks like:
 
-![Chrome inspect](../asset/contributing-inspect.png)
+![Chrome inspect](./asset/contributing-inspect.png)
+
+
+### 4. Add test cases
+
+In most cases, one or more test cases should be added when developing a feature or fixing a bug.
+All of the existing test cases are in directory `~/workspace/echarts/test`.
+Check the file `~/workspace/echarts/test/dataZoom-action.html` as an example.
+
+**Organize test cases:**
+Each file can be regard as a **test suite** and each chart in the file can be regard as a **test case**,
+which contains one or multiple expected results (check points).
+If a feature or bug is related to a chart type or a component type, probably it should belongs to
+a test file named `chartOrComponentType-someSubCategory.html`. Or some common feature is related
+to multiple chart or component or has nothing to do with chart and component, probably it should
+belongs a test file named `featureName-someSubCateogory.html`.
+
+**The naming of a test file:**
+Generally speaking, the name of the test file should start with a chart type or component type
+or a common feature name (like "hoverStyle", "clip").
+
+**Add a test case:**
+If intending to add a test case, firstly try to find in the existing test files which file this
+new test case might belongs to.
+If an existing file found, add the test case to the file.
+Otherwise, add a new test file by commands as follows:
+
+```shell
+# Make a file named "bar-action.html" in directory "echarts/test" with 1 initial chart.
+npm run mktest bar-action
+# or `npm run mktest bar-action.html`
+
+# Make a file named "bar-action.html" in directory "echarts/test" with 5 initial charts.
+npm run mktest bar-action 5
+```
+
+**The expected results and the instructions of user interaction:**
+Although we have auto-visual-test tool to run tests, we should better write the expected result
+(check points) for each test cases for manual checking.
+Some cases need user interactions involved. The instructions should be written clearly.
+The expected results and the user instructions should be written in the `title` filed when
+creating a test by `testHelper.create` as follows:
+
+```js
+var chart = testHelper.create(echarts, 'main0', {
+    title: [
+        'Hover on the red circle',
+        '**A blue label** should appear on the **top of red circle**.'
+    ],
+    option: option
+});
+```
+
+
+### 5. Run test cases
+
+```bash
+# puppeteer is not in the devDependencies and needs to be installed manually
+npm install puppeteer --no-save
+npm run test:visual
+```
+
+It will run all the test cases under `~/workspace/echarts/test` automatically to compare with the previous version. You can use this to check if your code bring some breaking change.
+
+
+### 6. Check the code style
+
+The code style should follow the [Code Standard](https://echarts.apache.org/en/coding-standard.html).
+
+It is recommanded to install [eslint](https://eslint.org) plugin to in your IDE to find the invalid code style.
+Otherwise, we can also use
+```bash
+npm run lint
+```
+to check the the code style.
+
 
-### 4. Make a pull request
+### 7. Make a pull request
 
 Fork ECharts project into your own project. Checkout a branch from master branch named `fix-xxxx`, where xxxx is the issue id related. If there's no related issue, you need to create one in most cases to describe what's wrong or what new feature is required.
 

README.md

@@ -9,16 +9,16 @@ ECharts is a free, powerful charting and visualization library offering an easy
 Now ECharts is an incubator project of Apache Software Foundation.
 Please check its incubator status [here](http://incubator.apache.org/projects/echarts.html)
 
-**[中文官网](http://echarts.baidu.com)** | **[ENGLISH HOMEPAGE](https://echarts.apache.org/index.html)**
+**[中文官网](https://echarts.apache.org/zh/index.html)** | **[ENGLISH HOMEPAGE](https://echarts.apache.org/index.html)**
 
-[![Build Status](https://travis-ci.org/apache/incubator-echarts.svg?branch=master)](https://travis-ci.org/apache/incubator-echarts) [![](https://img.shields.io/npm/dw/echarts.svg?label=npm%20downloads&style=flat)](https://www.npmjs.com/package/echarts) ![Commits Since 4.0.0](https://img.shields.io/github/commits-since/apache/incubator-echarts/4.0.0.svg?colorB=%234c1&style=flat)
+[![Build Status](https://travis-ci.org/apache/incubator-echarts.svg?branch=master)](https://travis-ci.org/apache/incubator-echarts) [![](https://img.shields.io/npm/dw/echarts.svg?label=npm%20downloads&style=flat)](https://www.npmjs.com/package/echarts) [![Last npm release](https://img.shields.io/npm/v/echarts)](https://www.npmjs.com/package/echarts)
 
 ## Get ECharts
 
 You may choose one of the following methods:
 
-+ Download from Official Website in [中文下载页](http://echarts.baidu.com/download.html)
-+ Download from Official Website in [English](https://ecomfe.github.io/echarts-doc/public/en/download.html)
++ Download from Official Website in [中文下载页](https://echarts.apache.org/zh/download.html)
++ Download from Official Website in [English](https://echarts.apache.org/en/download.html)
 + `npm install echarts --save`
 + CDN: [jsDelivr CDN](https://www.jsdelivr.com/package/npm/echarts?path=dist)
 
@@ -32,136 +32,79 @@ ECharts-GL is an extension pack of ECharts, which provides 3D plots, globe visua
 
 ## Docs
 
-+ [Tutorial](http://echarts.baidu.com/tutorial.html)
-    + [中文](http://echarts.baidu.com/tutorial.html)
-    + [English](http://ecomfe.github.io/echarts-doc/public/en/tutorial.html)
++ Tutorial
+    + [中文](https://echarts.apache.org/zh/tutorial.html)
+    + [English](https://echarts.apache.org/en/tutorial.html)
 
-+ [API](http://echarts.baidu.com/api.html)
-    + [中文](http://echarts.baidu.com/api.html)
-    + [English](http://ecomfe.github.io/echarts-doc/public/en/api.html)
++ API
+    + [中文](https://echarts.apache.org/zh/api.html)
+    + [English](https://echarts.apache.org/en/api.html)
 
-+ [Option Manual](http://echarts.baidu.com/option.html)
-    + [中文](http://echarts.baidu.com/option.html)
-    + [English](http://ecomfe.github.io/echarts-doc/public/en/option.html)
++ Option Manual
+    + [中文](https://echarts.apache.org/zh/option.html)
+    + [English](https://echarts.apache.org/en/option.html)
 
-## Resources
-
-
-### Awesome ECharts
-
-[https://github.com/ecomfe/awesome-echarts](https://github.com/ecomfe/awesome-echarts)
-
-### Official Extensions
-
-+ [水球图 Liquidfill](https://github.com/ecomfe/echarts-liquidfill)
-
-+ [字符云 Wordcloud](https://github.com/ecomfe/echarts-wordcloud)
-
-+ [Graph Modularity](https://github.com/ecomfe/echarts-graph-modularity) Graph modularity extension for community detection
-
-+ [百度地图扩展](https://github.com/ecomfe/echarts/tree/master/extension/bmap)
-
-+ [vue-echarts](https://github.com/ecomfe/vue-echarts) ECharts component for Vue.js
-
-+ [echarts-stat](https://github.com/ecomfe/echarts-stat) Statistics tool for ECharts
-
-
-### Developers Contributions
-
-
-#### GIS
-
-+ [leaflet-echarts](https://github.com/wandergis/leaflet-echarts3) by wandergis
-+ [arcgis-echarts](https://github.com/wandergis/arcgis-echarts3) by wandergis
+## Get Help
 
-+ [echarts-leaflet](https://github.com/gnijuohz/echarts-leaflet) by gnijuohz
++ [GitHub Issues](https://github.com/apache/incubator-echarts/issues) for bug report and feature requests
++ Email [dev@echarts.apache.org](dev@echarts.apache.org) for general questions
++ Subscribe [mailing list](https://echarts.apache.org/en/maillist.html) to get updated with the project
 
-+ [ol3Echarts](https://github.com/sakitam-fdd/ol3Echarts) by sakitam-fdd
-
-#### Map Data and Tools
-
-+ [echarts-mapmaker](https://github.com/echarts-maps/echarts-mapmaker) by chfw
-+ [echarts-cities-js](https://github.com/echarts-maps/echarts-cities-js) by chfw
-+ [echarts-china-cities-js](https://github.com/echarts-maps/echarts-china-cities-js) by chfw
-+ [echarts-countries-js](https://github.com/echarts-maps/echarts-countries-js) by chfw
-
-
-#### AngularJS Binding
-
-+ [angular-echarts](https://github.com/wangshijun/angular-echarts) by wangshijun
-+ [echarts-ng](https://github.com/bornkiller/echarts-ng) by bornkiller
-+ [ng-echarts](https://github.com/liekkas/ng-echarts) by liekkas
-+ [ngx-echarts](https://github.com/xieziyu/ngx-echarts) by xieziyu
-
-#### Ember Binding
-+ [echarts-ember](https://github.com/bruckwubete/echarts-ember) by [bruck wubete](https://github.com/bruckwubete)
-+ [ember-cli-echarts](https://github.com/funnelcloudinc/ember-cli-echarts) by FunnelCloud
-
-#### Vue Component
-
-+ [vue-echarts](https://github.com/ecomfe/vue-echarts) by ecomfe
-+ [vue-echarts](https://github.com/panteng/vue-echarts) by panteng
-+ [vue-echarts-v3](https://github.com/xlsdg/vue-echarts-v3) by xlsdg
-
-#### React Component
-
-+ [echarts-for-react](https://github.com/hustcc/echarts-for-react) by hustcc
-+ [react-echarts](https://github.com/somonus/react-echarts) by somonus
-+ [re-echarts](https://github.com/liekkas/re-echarts) by liekkas
-+ [react-echarts-v3](https://github.com/xlsdg/react-echarts-v3) by xlsdg
-+ [d2recharts](https://github.com/leungwensen/d2recharts) by leungwensen
-+ [react-component-echarts](https://github.com/dawiwt/react-component-echarts) by dawiwt
-
-#### React Native Component
-
-+ [react-native-echarts](https://github.com/somonus/react-native-echarts) by somonus
+## Build
 
-### Other Languages
-#### Python
+Build echarts source code:
 
-+ [echarts-python](https://github.com/yufeiminds/echarts-python) by yufeiminds
-+ [krisk](https://github.com/napjon/krisk) by napjon
-+ [pyecharts](https://github.com/chenjiandongx/pyecharts) by chenjiandong
+Execute the instructions in the root directory of the echarts:
+([Node.js](https://nodejs.org) is required)
 
-#### R
+```shell
+# Install the dependencies from NPM:
+npm install
 
-+ [recharts](https://github.com/taiyun/recharts) by taiyun
-+ [recharts](https://github.com/yihui/recharts) by yihui
-+ [ECharts2Shiny](https://github.com/XD-DENG/ECharts2Shiny) by XD-DENG
-+ [echarts4r](https://github.com/JohnCoene/echarts4r) by JohnCoene
+# If intending to build and get all types of the "production" files:
+npm run release
+# The same as `node build/build.js --release`
 
-#### Julia
+# If only intending to get `dist/echarts.js`, which is usually
+# enough in dev or running the tests:
+npm run build
+# The same as `node build/build.js`
 
-+ [ECharts.jl](https://github.com/randyzwitch/ECharts.jl) by randyzwitch
+# Get the same "production" files as `node build/build.js`, while
+# watching the editing of the source code. Usually used in dev.
+npm run watch
+# The same as `node build/build.js -w`
 
-#### PureScript
+# Check the manual:
+npm run help
+# The same as `node build/build.js --help`
+```
 
-+ [purescript-echarts](https://github.com/slamdata/purescript-echarts/)
+Then the "production" files are generated in `dist` directory.
 
-#### iOS
+More custom build approaches can be checked in this tutorial: [Create Custom Build of ECharts](https://echarts.apache.org/en/tutorial.html#Create%20Custom%20Build%20of%20ECharts) please.
 
-+ [iOS-Echarts](https://github.com/Pluto-Y/iOS-Echarts) by Pluto-Y
+## Contribution
 
-#### Java
+If you wish to debug locally, or make pull requests, please refer to [contributing](https://github.com/apache/incubator-echarts/blob/master/CONTRIBUTING.md) document.
 
-+ [ECharts-Java](http://www.oschina.net/p/echarts-java) by Liuzh_533
+## Resources
 
-#### .NET
+### Awesome ECharts
 
-+ [EChartsSDK](https://github.com/idoku/EChartsSDK) by idoku
+[https://github.com/ecomfe/awesome-echarts](https://github.com/ecomfe/awesome-echarts)
 
-#### PHP
+### Extensions
 
-+ [Echarts-PHP](https://github.com/hisune/Echarts-PHP) by hisune
++ [Liquidfill 水球图](https://github.com/ecomfe/echarts-liquidfill)
 
-#### Node
++ [Wordcloud 字符云](https://github.com/ecomfe/echarts-wordcloud)
 
-+ [Node-Echarts](https://github.com/suxiaoxin/node-echarts) by suxiaoxin
++ [Baidu Map 百度地图扩展](https://github.com/apache/incubator-echarts/tree/master/extension/bmap)
 
-## Build
++ [vue-echarts](https://github.com/ecomfe/vue-echarts) ECharts component for Vue.js
 
-Check this tutorial [Create Custom Build of ECharts](https://ecomfe.github.io/echarts-doc/public/en/tutorial.html#Create%20Custom%20Build%20of%20ECharts)
- please.
++ [echarts-stat](https://github.com/ecomfe/echarts-stat) Statistics tool for ECharts
 
 ## License
 
@@ -171,9 +114,8 @@ ECharts is available under the Apache License V2.
 
 Please refer to [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html).
 
-## Reference Paper
+## Publication
 
 Deqing Li, Honghui Mei, Yi Shen, Shuang Su, Wenli Zhang, Junting Wang, Ming Zu, Wei Chen.
-[ECharts: A Declarative Framework for Rapid Construction of Wed-based Visualization](https://www.sciencedirect.com/science/article/pii/S2468502X18300068).
+[ECharts: A Declarative Framework for Rapid Construction of Web-based Visualization](https://www.sciencedirect.com/science/article/pii/S2468502X18300068).
 Visual Informatics, 2018.
-