Merge branch 'master' into fix-contributing-doc

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report	
+about: Help us to improve this project
+
+---
+**Please check the FAQ documentation before raising an issue**
+
+Please check the old issues before raising an issue in case someone has asked the same question that you are asking.
+
+**Describe the bug (__must be provided__)**
+
+A clear and concise description of what the bug is.
+
+**Your Environments (__must be provided__)**
+
+* OS: `uname -a`
+* Compliler: `g++ --version` or `clang++ --version`
+* CPU: `lscpu`
+* Commit id (e.g. `a3ffc7d8`)
+
+**How To Reproduce(__must be provided__)**
+
+Steps to reproduce the behavior:
+
+1. Step 1
+2. Step 2
+3. Step 3
+
+**Expected behavior**
+
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+
+Provide logs and configs, or any other context to trace the problem.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,58 @@
+<!--
+Thank you for contributing to **OceanBase**! Please read the [CONTRIBUTING](https://github.com/oceanbase/oceanbase/blob/master/CONTRIBUTING.md) document **BEFORE** filing this PR.
+-->
+
+### What changes were proposed in this pull request?
+
+<!--
+Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue. 
+If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
+  1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
+  2. If you fix some nGQL features, you can provide some references.
+  3. If there is design documentation, please add the link.
+  4. If there is a discussion in the mailing list, please add the link.
+-->
+
+
+### Why are the changes needed?
+
+<!--
+Please clarify why the changes are needed. For instance,
+  1. If you propose a new API, clarify the use case for a new API.
+  2. If you fix a bug, you can clarify why it is a bug.
+-->
+
+
+### Will break the compatibility? How if so?
+
+
+<!--
+Please label `alert/break' if so, such as
+  1. nGQL grammar changes;
+  2. RPC protocol can't be compatible with previous, refer to https://diwakergupta.github.io/thrift-missing-guide/#_versioning_compatibility;
+  3. Storage format; etc.
+-->
+
+
+### Does this PR introduce any user-facing change?
+
+<!--
+If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
+If no, write 'No'.
+-->
+
+
+### How was this patch tested?
+
+<!--
+If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
+If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
+If tests were not added, please describe why they were not added and/or why it was difficult to add.
+-->
+
+### Checklist
+<!--Tick the checkbox(es) below to choose what you have done.-->
+
+- [ ] I've run the tests to see all new and existing tests pass.
+- [ ] If this Pull Request resolves an issue, I linked to the issue in the text above.
+- [ ] I've informed the technical writer about the documentation change if necessary.

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)?
 
@@ -93,5 +93,6 @@ 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 <https://github.com/$user/oceanbase> (replace `$user` with your GitHub account).
+1. Visit your fork at <https://github.com/$user/oceanbase> (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.

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)。
 
 ## 获取帮助
 

README.md

@@ -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.
@@ -38,14 +38,20 @@ OceanBase Database is under [MulanPubL - 2.0](https://license.coscl.org.cn/Mulan
 
 ## How to build
 
-#### debug mode
-> sh build.sh debug --init --make
+### debug mode
+```sh
+sh build.sh debug --init --make
+```
 
-#### release mode
-> sh build.sh release --init --make
+### release mode
+```sh
+sh build.sh release --init --make
+```
 
-#### rpm packages
-> sh build.sh rpm --init && cd build_rpm && make -j16 rpm
+### rpm packages
+```sh
+sh build.sh rpm --init && cd build_rpm && make -j16 rpm
+```
 
 ## Contributing