diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f45fd31acc85533074ee4d696eb3ff526c1dcc1f..65a67f0d15b11fb6b415adc3958b4675097fc90a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ OceanBase Database is a community-driven open source project and we welcome all ## Before you contribute -Before you contribute, please click the **Sign in with Github to agree button** to sign the CLA. You can find an example [here](https://cla-assistant.io/oceanbase/oceanbase). +Before you contribute, please click the **Sign in with GitHub to agree button** to sign the CLA. You can find an example [here](https://cla-assistant.io/oceanbase/oceanbase). What is [CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement)? @@ -90,5 +90,5 @@ git push -u origin new-branch-name # "-u" is used to track the remote branch fro ### Step 8: Create a pull request -1. Visit your fork at (replace `$user` with your GitHub account). +1. Visit your fork at (replace `$user` with the GitHub account which you performed the fork operation, the repo name is `oceanbase` by default and you may want to modify it). 2. Click the `Compare & pull request` button next to your `new-branch-name` branch to create your PR. diff --git a/README-CN.md b/README-CN.md index 018fcb3a259dde4423ebf1cdabede56dc7b6b956..6eebd910341f83bcd81e450bbacf856e8120b1c3 100644 --- a/README-CN.md +++ b/README-CN.md @@ -21,7 +21,7 @@ OceanBase 数据库支持支付宝的全部核心业务,以及银行、保险 ## 快速上手 -请查看 [快速使用指南](https://open.oceanbase.com/quickStart) 开始试用 OceanBse 数据库。 +请查看 [快速使用指南](https://open.oceanbase.com/quickStart) 开始试用 OceanBase 数据库。 ## 文档 @@ -45,7 +45,7 @@ OceanBase 数据库使用 [MulanPubL - 2.0](https://license.coscl.org.cn/MulanPu 我们十分欢迎并感谢您为我们贡献。以下是您参与贡献的几种方式: - 向我们提 [issue](https://github.com/oceanbase/oceanbase/issues)。 -- 提交 PR。详情参见 [如何贡献](CONTRIBUTING.md)。 +- 提交 PR,详情参见 [如何贡献](CONTRIBUTING.md)。 ## 获取帮助 diff --git a/README.md b/README.md index 1933e5379cd00d7e87b0483ebee1f7bbbad38373..99ff27d35e574299f968d4449b68cf91c54e2eab 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # What is OceanBase database -OceanBase Database is a native distributed relational database. It is developed entirely by Alibaba and Ant Group. OceanBase Database is built on a common server cluster. Based on the Paxos protocol and its distributed structure, OceanBase Database provides high availability and linear scalability for financial institutions. OceanBase Database is not dependent on specific hardware architectures. +OceanBase Database is a native distributed relational database. It is developed entirely by Alibaba and Ant Group. OceanBase Database is built on a common server cluster. Based on the Paxos protocol and its distributed structure, OceanBase Database provides high availability and linear scalability. OceanBase Database is not dependent on specific hardware architectures. OceanBase Database has these features: @@ -8,7 +8,7 @@ OceanBase Database has these features: Single server failure recovers automatically. OceanBase Database supports cross-city disaster tolerance for multiple IDCs and zero data loss. OceanBase Database meets the financial industry Level 6 disaster recovery standard (RPO=0, RTO<=30 seconds). - Linear scalability OceanBase Database scales transparently to applications and balances the system load automatically. Its cluster can contain more than 1500 nodes. The data volume can reach petabytes. The records in a single table can be more than a trillion rows. -- High compatible with MySQL +- Highly compatible with MySQL OceanBase Database is compatible with MySQL protocol and syntax. You can access to OceanBase Database by using MySQL client. - High performance OceanBase Database supports quasi memory level data change and exclusive encoding compression. Together with the linear scalability, OceanBase Database provides high performance. @@ -39,13 +39,19 @@ OceanBase Database is under [MulanPubL - 2.0](https://license.coscl.org.cn/Mulan ## How to build ### debug mode -> sh build.sh debug --init --make +```sh +sh build.sh debug --init --make +``` ### release mode -> sh build.sh release --init --make +```sh +sh build.sh release --init --make +``` ### rpm packages -> sh build.sh rpm --init && cd build_rpm && make -j16 rpm +```sh +sh build.sh rpm --init && cd build_rpm && make -j16 rpm +``` ## Contributing