[incubator-echarts.wiki] branch master updated: Updated How to setup a dev environment (markdown)

2019-12-22 Thread ovilia
This is an automated email from the ASF dual-hosted git repository.

ovilia pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-echarts.wiki.git


The following commit(s) were added to refs/heads/master by this push:
 new f344ff7  Updated How to setup a dev environment (markdown)
f344ff7 is described below

commit f344ff77a9f65a8f3257083c0fe5ff62bc250f28
Author: Ovilia 
AuthorDate: Mon Dec 23 13:16:21 2019 +0800

Updated How to setup a dev environment (markdown)
---
 ...to-setup-a-dev-environment.md => How-to-setup-the-dev-environment.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/How-to-setup-a-dev-environment.md 
b/How-to-setup-the-dev-environment.md
similarity index 96%
rename from How-to-setup-a-dev-environment.md
rename to How-to-setup-the-dev-environment.md
index cd4bb37..498696b 100644
--- a/How-to-setup-a-dev-environment.md
+++ b/How-to-setup-the-dev-environment.md
@@ -1,4 +1,4 @@
-The following steps help you to set up a developing environment for ECharts.
+The following steps help you to set up the developing environment for ECharts.
 
 ### 1. Clone the ECharts project
 


-
To unsubscribe, e-mail: commits-unsubscr...@echarts.apache.org
For additional commands, e-mail: commits-h...@echarts.apache.org



[incubator-echarts.wiki] branch master updated: Updated How to setup a dev environment (markdown)

2019-12-22 Thread ovilia
This is an automated email from the ASF dual-hosted git repository.

ovilia pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-echarts.wiki.git


The following commit(s) were added to refs/heads/master by this push:
 new c3fbe8f  Updated How to setup a dev environment (markdown)
c3fbe8f is described below

commit c3fbe8fb4ec613f44b46881b52e8934cc7beb307
Author: Ovilia 
AuthorDate: Mon Dec 23 13:14:39 2019 +0800

Updated How to setup a dev environment (markdown)
---
 How-to-setup-a-dev-environment.md | 64 ---
 1 file changed, 64 deletions(-)

diff --git a/How-to-setup-a-dev-environment.md 
b/How-to-setup-a-dev-environment.md
index c9c9f8a..cd4bb37 100644
--- a/How-to-setup-a-dev-environment.md
+++ b/How-to-setup-a-dev-environment.md
@@ -62,70 +62,6 @@ Then, open the test cases under `~/workspace/echarts/test` 
in Web browser. You c
 ![Chrome 
inspect](https://github.com/apache/incubator-echarts/raw/master/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
-
-Before making a pull request, you must run `npm run test` locally to do the 
unit tests.
-
-Visual tests are optional. If you changed view related logic, please test the 
related visual cases. For example, if you add a new layout for pie chart 
labels, you should run the visual tests of all pie test cases and add new cases 
if needed.
-
-```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.
 
 ### Next Steps
 


-
To unsubscribe, e-mail: commits-unsubscr...@echarts.apache.org
For additional commands, e-mail: commits-h...@echarts.apache.org