This is an automated email from the ASF dual-hosted git repository.
indhumuthumurugesh pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/carbondata.git
The following commit(s) were added to refs/heads/master by this push:
new 26e9182 [Doc] syntax and format issues in README.md and
how-to-contribute-to-apache-carbondata.md
26e9182 is described below
commit 26e9182e371e71fbea78cfc692987ec095566942
Author: Ting Sun <[email protected]>
AuthorDate: Fri May 14 20:33:53 2021 +0800
[Doc] syntax and format issues in README.md and
how-to-contribute-to-apache-carbondata.md
Why is this PR needed?
To improve the quality of README.md and
how-to-contribute-to-apache-carbondata.md.
What changes were proposed in this PR?
Syntax and format changes.
This closes #4136
---
README.md | 10 +++++-----
docs/how-to-contribute-to-apache-carbondata.md | 12 ++++++------
2 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index d1b47af..d143e7c 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@
<img src="/docs/images/CarbonData_logo.png" width="200" height="40">
-Apache CarbonData is an indexed columnar data store solution for fast
analytics on big data platform, e.g.Apache Hadoop, Apache Spark, etc.
+Apache CarbonData is an indexed columnar data store solution for fast
analytics on big data platform, e.g. Apache Hadoop, Apache Spark, etc.
You can find the latest CarbonData document and learn more at:
[http://carbondata.apache.org](http://carbondata.apache.org/)
@@ -33,9 +33,9 @@ Spark2.4:
src="https://scan.coverity.com/projects/13444/badge.svg"/>
</a>
## Features
-CarbonData file format is a columnar store in HDFS, it has many features that
a modern columnar format has, such as splittable, compression schema ,complex
data type etc, and CarbonData has following unique features:
+CarbonData file format is a columnar store in HDFS, it has many features that
a modern columnar format has, such as splittable, compression schema, complex
data type etc, and CarbonData has following unique features:
* Stores data along with index: it can significantly accelerate query
performance and reduces the I/O scans and CPU resources, where there are
filters in the query. CarbonData index consists of multiple level of indices,
a processing framework can leverage this index to reduce the task it needs to
schedule and process, and it can also do skip scan in more finer grain unit
(called blocklet) in task side scanning instead of scanning the whole file.
-* Operable encoded data :Through supporting efficient compression and global
encoding schemes, can query on compressed/encoded data, the data can be
converted just before returning the results to the users, which is "late
materialized".
+* Operable encoded data: through supporting efficient compression and global
encoding schemes, can query on compressed/encoded data, the data can be
converted just before returning the results to the users, which is "late
materialized".
* Supports for various use cases with one single Data format : like
interactive OLAP-style query, Sequential Access (big scan), Random Access
(narrow scan).
## Building CarbonData
@@ -74,7 +74,7 @@ Some features are marked as experimental because the
syntax/implementation might
2. Accelerating performance using MV on parquet/orc.
3. Merge API for Spark DataFrame.
4. Hive write for non-transactional table.
-5. Secondary Index as a Coarse Grain Index in query processing
+5. Secondary Index as a Coarse Grain Index in query processing.
## Integration
* [Hive](https://github.com/apache/carbondata/blob/master/docs/hive-guide.md)
@@ -88,7 +88,7 @@ Some features are marked as experimental because the
syntax/implementation might
## Fork and Contribute
This is an active open source project for everyone, and we are always open to
people who want to use this system or contribute to it.
-This guide document introduce [how to contribute to
CarbonData](https://github.com/apache/carbondata/blob/master/docs/how-to-contribute-to-apache-carbondata.md).
+This guide document introduces [how to contribute to
CarbonData](https://github.com/apache/carbondata/blob/master/docs/how-to-contribute-to-apache-carbondata.md).
## Contact us
To get involved in CarbonData:
diff --git a/docs/how-to-contribute-to-apache-carbondata.md
b/docs/how-to-contribute-to-apache-carbondata.md
index 8d6c891..8900a59 100644
--- a/docs/how-to-contribute-to-apache-carbondata.md
+++ b/docs/how-to-contribute-to-apache-carbondata.md
@@ -20,7 +20,7 @@
The Apache CarbonData community welcomes all kinds of contributions from
anyone with a passion for
faster data format! Apache CarbonData is a new file format for faster
interactive query using
advanced columnar storage, index, compression and encoding techniques to
improve computing
-efficiency,in turn it will help speedup queries an order of magnitude faster
over PetaBytes of data.
+efficiency, in turn it will help speedup queries by order of magnitude faster
over PetaBytes of data.
We use a review-then-commit workflow in CarbonData for all contributions.
@@ -37,7 +37,7 @@ emailing [email protected]
We use [Apache JIRA](https://issues.apache.org/jira/browse/CARBONDATA) as an
issue tracking and
project management tool, as well as a way to communicate among a very diverse
and distributed set
-of contributors. To be able to gather feedback, avoid frustration, and avoid
duplicated efforts all
+of contributors. To be able to gather feedback, avoid frustration and avoid
duplicated efforts, all
CarbonData-related work should be tracked there.
If you do not already have an Apache JIRA account, sign up
[here](https://issues.apache.org/jira/).
@@ -134,7 +134,7 @@ $ mvn clean verify
Once the initial code is complete and the tests pass, it’s time to start the
code review process.
We review and discuss all code, no matter who authors it. It’s a great way to
build community,
since you can learn from other developers, and they become familiar with your
contribution.
-It also builds a strong project by encouraging a high quality bar and keeping
code consistent
+It also builds a strong project by encouraging a high-quality bar and keeping
code consistent
throughout the project.
#### Create a pull request
@@ -153,7 +153,7 @@ Please include a descriptive pull request message to help
make the reviewer’s
```
- The root cause/problem statement
- What is the implemented solution
- ```
+```
If you know a good committer to review your pull request, please make a
comment like the following.
If not, don’t worry, a committer will pick it up.
@@ -165,10 +165,10 @@ Hi @<committer/reviewer name>, can you please take a look?
During the code review process, don’t rebase your branch or otherwise modify
published commits,
since this can remove existing comment history and be confusing to the
reviewer,
-When you make a revision, always push it in a new commit.
+When you make a revision, always push it into a new commit.
Our GitHub mirror automatically provides pre-commit testing coverage using
Jenkins.
-Please make sure those tests pass,the contribution cannot be merged otherwise.
+Please make sure those tests pass, the contribution cannot be merged otherwise.
#### LGTM
Once the reviewer is happy with the change, they’ll respond with an LGTM
("looks good to me!").
![https://scan.coverity.com/projects/13444/badge.svg"/](https://scan.coverity.com/projects/13444/badge.svg"/){kind=link}