echarts 4.5.0-rc.1 → 4.7.0

package/.github/pull_request_template.md

@@ -0,0 +1,66 @@
+<!-- Please fill in the following information to help us review your PR more efficiently. -->
+
+## Brief Information
+
+This pull request is in the type of:
+
+- [ ] bug fixing
+- [ ] new feature
+- [ ] others
+
+
+
+### What does this PR do?
+
+<!-- USE ONCE SENTENCE TO DESCRIBE WHAT THIS PR DOES. -->
+
+
+
+### Fixed issues
+
+<!--
+- #xxxx: ...
+-->
+
+
+## Details
+
+### Before: What was the problem?
+
+<!-- DESCRIBE THE BUG OR REQUIREMENT HERE. -->
+
+<!-- ADD SCREENSHOT HERE IF APPLICABLE. -->
+
+
+
+### After: How is it fixed in this PR?
+
+<!-- THE RESULT AFTER FIXING AND A SIMPLE EXPLANATION ABOUT HOW IT IS FIXED. -->
+
+<!-- ADD SCREENSHOT HERE IF APPLICABLE. -->
+
+
+
+## Usage
+
+### Are there any API changes?
+
+- [ ] The API has been changed.
+
+<!-- LIST THE API CHANGES HERE -->
+
+
+
+### Related test cases or examples to use the new APIs
+
+NA.
+
+
+
+## Others
+
+### Merging options
+
+- [ ] Please squash the commits into a single one when merge.
+
+### Other information

package/.github/workflows/nodejs.yml

@@ -21,11 +21,21 @@ jobs:
         run: |
           npm install
           npm install -g jshint
+          npm install git+https://github.com/ecomfe/zrender.git
+      - name: build zrender
+        run: |
+          cd node_modules/zrender
+          npm install
+          npm run prepublish
+          cd ../..
       - name: jshint
         run: |
           jshint
-      - name: build
+      - name: build release
         run: |
-          node build/build.js
+          npm run release
         env:
           CI: true
+      - name: unit test
+        run: |
+          npm run test

package/CONTRIBUTING.md

@@ -2,7 +2,20 @@
 
 👍🎉 First off, thanks for taking the time to contribute! 🎉👍
 
-Please check out the [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html).
+Please check out the [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html) first.
+
+## What can you do for the ECharts community?
+
+Contributions can be made in varied ways:
+
+- Help others in the issues
+    - Help solve problems with the issues
+    - Remind the authors to provide a demo if they are reporting for a bug
+    - Try to reproduce the problem as describe in the issues
+- Make pull requests to fix bugs or implement new features
+- Mend or translate the documents
+- Discuss in the [mailing list](https://echarts.apache.org/en/maillist.html)
+- ...
 
 ## Issues
 
@@ -26,168 +39,11 @@ About our release plan, we will release a mior version at the end of every month
 
 ## Pull Requests
 
-### 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).
-
+Wiki: [How to make a pull request](https://github.com/apache/incubator-echarts/wiki/How-to-make-a-pull-request)
 
 ## 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.
-
-```bash
-git clone git@github.com:apache/incubator-echarts.git
-```
-
-[ZRender](https://github.com/ecomfe/zrender) is the rendering library under the hood. You need to clone it along with ECharts.
-
-```bash
-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
-cd ~/workspace/echarts
-npm install
-cd ~/workspace/zrender
-npm install
-```
-
-Sometimes, in order to fix an issue within echarts, changes have to be made inside the codebase of zrender. To test any changes to zrender locally you can use npm's [npm link](https://docs.npmjs.com/cli/link.html) feature, for example:
-
-```bash
-cd ~/workspace/zrender
-npm link
-cd ~/workspace/echarts
-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:
-
-```bash
-cd ~/workspace/echarts
-node build/build.js --watch
-```
-
-To build once:
-
-```bash
-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)
-
-
-### 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.
-
-
-### 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.
-
-If you are a committer of apache/incubator-echarts project, which means you have the write access to the project, you still need to push to a new branch (by `git push origin HEAD:refs/heads/fix-xxxx`) and use pull request to push your code. You cannot push code directly to `master` branch, otherwise it will be rejected by GitHub.
-
+Wiki: [How to setup the dev environment](https://github.com/apache/incubator-echarts/wiki/How-to-setup-the-dev-environment)
 
 ## Some hints about using code from other authors
 

package/NOTICE

@@ -1,5 +1,5 @@
 Apache ECharts (incubating)
-Copyright 2017-2019 The Apache Software Foundation
+Copyright 2017-2020 The Apache Software Foundation
 
 This product includes software developed at
 The Apache Software Foundation (http://www.apache.org/).

package/README.md

@@ -1,6 +1,6 @@
 # ECharts
 
-<a href="http://echarts.baidu.com">
+<a href="https://echarts.apache.org/">
     <img style="vertical-align: top;" src="./asset/logo.png?raw=true" alt="logo" height="50px">
 </a>
 
@@ -9,7 +9,7 @@ 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)
 
-**[中文官网](https://echarts.apache.org/zh/index.html)** | **[ENGLISH HOMEPAGE](https://echarts.apache.org/index.html)**
+**[中文官网](https://echarts.apache.org/zh/index.html)** | **[ENGLISH HOMEPAGE](https://echarts.apache.org/en/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) [![Last npm release](https://img.shields.io/npm/v/echarts)](https://www.npmjs.com/package/echarts)
 
@@ -22,14 +22,6 @@ You may choose one of the following methods:
 + `npm install echarts --save`
 + CDN: [jsDelivr CDN](https://www.jsdelivr.com/package/npm/echarts?path=dist)
 
-## Get ECharts GL
-
-ECharts-GL is an extension pack of ECharts, which provides 3D plots, globe visualization, and WebGL acceleration.
-
-+ Get from [https://github.com/ecomfe/echarts-gl](https://github.com/ecomfe/echarts-gl)
-
-+ `npm install echarts-gl --save`
-
 ## Docs
 
 + Tutorial
@@ -96,11 +88,13 @@ If you wish to debug locally or make pull requests, please refer to [contributin
 
 ### Extensions
 
++ [ECharts GL](https://github.com/ecomfe/echarts-gl) An extension pack of ECharts, which provides 3D plots, globe visualization, and WebGL acceleration.
+
 + [Liquidfill 水球图](https://github.com/ecomfe/echarts-liquidfill)
 
 + [Wordcloud 字符云](https://github.com/ecomfe/echarts-wordcloud)
 
-+ [Baidu Map 百度地图扩展](https://github.com/apache/incubator-echarts/tree/master/extension/bmap)
++ [Extension for Baidu Map 百度地图扩展](https://github.com/apache/incubator-echarts/tree/master/extension/bmap) An extension provides a wrapper of Baidu Map Service SDK. 
 
 + [vue-echarts](https://github.com/ecomfe/vue-echarts) ECharts component for Vue.js