Skip to content

Commit 8120aab

Browse files
authored
docs: fix a lot of grammatical errors in CONTRIBUTING.md (#18244)
* Made some grammatical changes in the Readme.md Files * Fixed Grammatical errors in CONTRIBUTING.md
1 parent 2d8bc8f commit 8120aab

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

CONTRIBUTING.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Please check out the [Apache Code of Conduct](https://www.apache.org/foundation/
88

99
Contributions can be made in varied ways:
1010

11-
- Help others in the issues
11+
- Help others with the issues
1212
- 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
1414
- Try to reproduce the problem as described in the issues
1515
- Make pull requests to fix bugs or implement new features
1616
- Improve or translate the documents
@@ -19,22 +19,22 @@ Contributions can be made in varied ways:
1919

2020
## Issues
2121

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.
2323

2424
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.
2525

2626
Please read the [documentation](http://echarts.apache.org/option.html) carefully before asking any questions.
2727

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.
2929

3030
## Release Milestone Discussion
3131

3232
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.
3333

3434
Regarding the release plan, we will release a minor version at the end of every month. Here is some detail.
3535

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)
3838
3. Vote in the mailing list for the 4.4.0 release at the end of this month.
3939

4040
## Pull Requests
@@ -47,23 +47,23 @@ Wiki: [How to setup the dev environment](https://github.com/apache/echarts/wiki/
4747

4848
## Some hints about using code from other authors
4949

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.
5252
+ But when you copy the code, even parts of files, it must remain under the copyright of the original authors.
5353
+ What's the right thing to do for the public good here? I'll go with:
5454
+ Be transparent when implementing an existing idea/algorithm.
5555
+ Reference where that idea/algorithm came from.
5656
+ Use standard language when doing so (we need to define standard language).
5757
+ "inspired by", "learned from" and "references to" are vague concepts in copyright.
5858
+ 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
6060
+ About adding the license/header of 3rd-party work:
6161
+ https://www.apache.org/legal/src-headers.html#3party
6262
+ Licenses that are compatible with the Apache license:
63-
+ BSD and MIT are compatible with the Apache license but CC_BY_SA is not (https://apache.org/legal/resolved.html#cc-sa).
63+
+ BSD and MIT are compatible with the Apache license, but CC_BY_SA is not (https://apache.org/legal/resolved.html#cc-sa).
6464
+ Stack Overflow:
65-
+ before intending to copy code from Stack Overflow, we must check:
65+
+ before intending to copy code from Stack Overflow, we must check the following:
6666
+ https://apache.org/legal/resolved.html#stackoverflow
6767
+ https://issues.apache.org/jira/browse/LEGAL-471
6868
+ 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.

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<img style="vertical-align: top;" src="./asset/logo.png?raw=true" alt="logo" height="50px">
55
</a>
66

7-
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 <a href="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 <a href="https://github.com/ecomfe/zrender">zrender</a>, which is a whole new lightweight canvas library.
88

99
**[中文官网](https://echarts.apache.org/zh/index.html)** | **[ENGLISH HOMEPAGE](https://echarts.apache.org/en/index.html)**
1010

@@ -45,12 +45,12 @@ Execute the instructions in the root directory of the echarts:
4545
npm install
4646

4747
# 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
4949
# of all test cases.
5050
# If you wish to create a test case, run `npm run mktest:help` to learn more.
5151
npm run dev
5252

53-
# Check correctness of TypeScript code.
53+
# Check the correctness of TypeScript code.
5454
npm run checktype
5555

5656
# 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.
6161

6262
## Contribution
6363

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.
6565

6666
## Resources
6767

0 commit comments

Comments
 (0)