You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+12-12
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,9 @@ Please check out the [Apache Code of Conduct](https://www.apache.org/foundation/
8
8
9
9
Contributions can be made in varied ways:
10
10
11
-
- Help others in the issues
11
+
- Help others with the issues
12
12
- Help solve problems with the issues
13
-
- Remind the authors to provide a demo if they are reporting for a bug
13
+
- Remind the authors to provide a demo if they are reporting a bug
14
14
- Try to reproduce the problem as described in the issues
15
15
- Make pull requests to fix bugs or implement new features
16
16
- Improve or translate the documents
@@ -19,22 +19,22 @@ Contributions can be made in varied ways:
19
19
20
20
## Issues
21
21
22
-
We have already prepared issue templates for bug report and feature request. If you want to fire an issue, just entering[New issue](https://github.com/apache/echarts/issues/new/choose) page and select either of them to get started.
22
+
We have already prepared issue templates for bug reports and feature requests. If you want to fire an issue, just enter the[New issue](https://github.com/apache/echarts/issues/new/choose) page and select either of them to get started.
23
23
24
24
Additionally, before doing so, please search for similar questions in our [issues list](https://github.com/apache/echarts/issues?utf8=%E2%9C%93&q=is%3Aissue). If you are able to reproduce an issue found in a closed issue, please create a new issue and reference the closed one.
25
25
26
26
Please read the [documentation](http://echarts.apache.org/option.html) carefully before asking any questions.
27
27
28
-
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.
28
+
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.
29
29
30
30
## Release Milestone Discussion
31
31
32
32
We will start the discussion about the bugs to fix and the features of each release in the [mailing list](https://echarts.apache.org/en/maillist.html). You may subscribe to our [mailing list](https://echarts.apache.org/en/maillist.html) to give your valuable advice in milestone discussions.
33
33
34
34
Regarding the release plan, we will release a minor version at the end of every month. Here is some detail.
35
35
36
-
1. Assume our current stable release is 4.3.0. We will start the discussion of the 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 development of the next release, which is 4.4.0.
37
-
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/echarts/milestone/14)
36
+
1. Assume our current stable release is 4.3.0. We will start the discussion of the milestone of the release two versions ahead, which is 4.5.0 at the beginning of each month. At this time, we should also kick off the development of the next release, which is 4.4.0.
37
+
2. Finish 4.4.0 development on about the 22nd 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/echarts/milestone/14)
38
38
3. Vote in the mailing list for the 4.4.0 release at the end of this month.
39
39
40
40
## Pull Requests
@@ -47,23 +47,23 @@ Wiki: [How to setup the dev environment](https://github.com/apache/echarts/wiki/
47
47
48
48
## Some hints about using code from other authors
49
49
50
-
+ About using some algorithms/formulas or inspired by other's work:
51
-
+ We can be inspired by other people’s work. There is no problem with copying ideas and no problems associated with that so long as the code is entirely yours and you aren’t violating the license of the inspirational work. You can just follow "normal" source code rules.
50
+
+ About using some algorithms/formulas or inspired by others' work:
51
+
+ We can be inspired by other people’s work. There is no problem with copying ideas and no problems associated with that as long as the code is entirely yours and you aren’t violating the license of the inspirational work. You can just follow "normal" source code rules.
52
52
+ But when you copy the code, even parts of files, it must remain under the copyright of the original authors.
53
53
+ What's the right thing to do for the public good here? I'll go with:
54
54
+ Be transparent when implementing an existing idea/algorithm.
55
55
+ Reference where that idea/algorithm came from.
56
56
+ Use standard language when doing so (we need to define standard language).
57
57
+ "inspired by", "learned from" and "references to" are vague concepts in copyright.
58
58
+ If any copyrightable expression is copied from the existing idea/algorithm, compare its licensing to our licensing policies and include licensing accordingly.
59
-
+ Check the original discussion about it in: https://lists.apache.org/[email protected]:lte=36M:echarts
59
+
+ Check the original discussion about it at: https://lists.apache.org/[email protected]:lte=36M:echarts
60
60
+ About adding the license/header of 3rd-party work:
+ Wikipedia (and most Wikimedia Foundation projects):
69
-
+ Wikipedia, and most Wikimedia Foundation projects, are licensed under CC 4.0 BY_SA (and sometimes GFDL) and is incompatible with the Apache license. Therefore, we should not copy code from Wikipedia, or Wikimedia Foundation projects.
69
+
+ Wikipedia, and most Wikimedia Foundation projects, are licensed under CC 4.0 BY_SA (and sometimes GFDL) and are incompatible with the Apache license. Therefore, we should not copy code from Wikipedia or Wikimedia Foundation projects.
Apache ECharts is a free, powerful charting and visualization library offering an easy way of adding intuitive, interactive, and highly customizable charts to your commercial products. It is written in pure JavaScript and based on <ahref="https://github.com/ecomfe/zrender">zrender</a>, which is a whole new lightweight canvas library.
7
+
Apache ECharts is a free, powerful charting and visualization library offering easy ways to add intuitive, interactive, and highly customizable charts to your commercial products. It is written in pure JavaScript and based on <ahref="https://github.com/ecomfe/zrender">zrender</a>, which is a whole new lightweight canvas library.
@@ -45,12 +45,12 @@ Execute the instructions in the root directory of the echarts:
45
45
npm install
46
46
47
47
# Rebuild source code immediately in watch mode when changing the source code.
48
-
# It opens the `./test` directory and you may open `-cases.html` to get the list
48
+
# It opens the `./test` directory, and you may open `-cases.html` to get the list
49
49
# of all test cases.
50
50
# If you wish to create a test case, run `npm run mktest:help` to learn more.
51
51
npm run dev
52
52
53
-
# Check correctness of TypeScript code.
53
+
# Check the correctness of TypeScript code.
54
54
npm run checktype
55
55
56
56
# If intending to build and get all types of the "production" files:
@@ -61,7 +61,7 @@ Then the "production" files are generated in the `dist` directory.
61
61
62
62
## Contribution
63
63
64
-
If you wish to debug locally or make pull requests, please refer to the [contributing](https://github.com/apache/echarts/blob/master/CONTRIBUTING.md) document.
64
+
Please refer to the [contributing](https://github.com/apache/echarts/blob/master/CONTRIBUTING.md) document if you wish to debug locally or make pull requests.
0 commit comments