forked from apache/echarts
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: fix a lot of grammatical errors in CONTRIBUTING.md (apache#18244)
* Made some grammatical changes in the Readme.md Files * Fixed Grammatical errors in CONTRIBUTING.md
- Loading branch information
1 parent
2d8bc8f
commit 8120aab
Showing
2 changed files
with
16 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/ | |
|
||
Contributions can be made in varied ways: | ||
|
||
- Help others in the issues | ||
- Help others with the issues | ||
- Help solve problems with the issues | ||
- Remind the authors to provide a demo if they are reporting for a bug | ||
- Remind the authors to provide a demo if they are reporting a bug | ||
- Try to reproduce the problem as described in the issues | ||
- Make pull requests to fix bugs or implement new features | ||
- Improve or translate the documents | ||
|
@@ -19,22 +19,22 @@ Contributions can be made in varied ways: | |
|
||
## Issues | ||
|
||
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. | ||
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. | ||
|
||
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. | ||
|
||
Please read the [documentation](http://echarts.apache.org/option.html) carefully before asking any questions. | ||
|
||
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. | ||
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 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. | ||
|
||
Regarding the release plan, we will release a minor 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 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. | ||
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) | ||
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. | ||
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) | ||
3. Vote in the mailing list for the 4.4.0 release at the end of this month. | ||
|
||
## Pull Requests | ||
|
@@ -47,23 +47,23 @@ Wiki: [How to setup the dev environment](https://github.com/apache/echarts/wiki/ | |
|
||
## Some hints about using code from other authors | ||
|
||
+ About using some algorithms/formulas or inspired by other's work: | ||
+ 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. | ||
+ About using some algorithms/formulas or inspired by others' work: | ||
+ 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. | ||
+ But when you copy the code, even parts of files, it must remain under the copyright of the original authors. | ||
+ What's the right thing to do for the public good here? I'll go with: | ||
+ Be transparent when implementing an existing idea/algorithm. | ||
+ Reference where that idea/algorithm came from. | ||
+ Use standard language when doing so (we need to define standard language). | ||
+ "inspired by", "learned from" and "references to" are vague concepts in copyright. | ||
+ If any copyrightable expression is copied from the existing idea/algorithm, compare its licensing to our licensing policies and include licensing accordingly. | ||
+ Check the original discussion about it in: https://lists.apache.org/[email protected]:lte=36M:echarts | ||
+ Check the original discussion about it at: https://lists.apache.org/[email protected]:lte=36M:echarts | ||
+ About adding the license/header of 3rd-party work: | ||
+ https://www.apache.org/legal/src-headers.html#3party | ||
+ Licenses that are compatible with the Apache license: | ||
+ BSD and MIT are compatible with the Apache license but CC_BY_SA is not (https://apache.org/legal/resolved.html#cc-sa). | ||
+ BSD and MIT are compatible with the Apache license, but CC_BY_SA is not (https://apache.org/legal/resolved.html#cc-sa). | ||
+ Stack Overflow: | ||
+ before intending to copy code from Stack Overflow, we must check: | ||
+ before intending to copy code from Stack Overflow, we must check the following: | ||
+ https://apache.org/legal/resolved.html#stackoverflow | ||
+ https://issues.apache.org/jira/browse/LEGAL-471 | ||
+ Wikipedia (and most Wikimedia Foundation projects): | ||
+ 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. | ||
+ 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters