Merge pull request #16098 from arielyang/main

docs: merge CONTRIBUTING files from develop branch

CONTRIBUTING-CN.md

+# 贡献指南
+
+我们感谢所有开发者提交贡献。随时关注我们，Fork 存储库，报告错误，以及在 GitHub 上提交您的代码。但是，我们希望开发者遵循我们的指南，才能更好的做出贡献。
+
+## 报告错误
+
+- 任何用户都可以通过 **[GitHub issue tracker](https://github.com/taosdata/TDengine/issues)** 向我们报告错误。请您对所遇到的问题进行**详细描述**，最好提供重现错误的详细步骤。
+- 欢迎提供包含由 Bug 生成的日志文件的附录。
+
+## 需要强调的代码提交规则
+
+- 在提交代码之前，需要**同意贡献者许可协议（CLA）**。点击 [TaosData CLA](https://cla-assistant.io/taosdata/TDengine) 阅读并签署协议。如果您不接受该协议，请停止提交。
+- 请在 [GitHub issue tracker](https://github.com/taosdata/TDengine/issues) 中解决问题或添加注册功能。
+- 如果在 [GitHub issue tracker](https://github.com/taosdata/TDengine/issues) 中没有找到相应的问题或功能，请**创建一个新的 issue**。
+- 将代码提交到我们的存储库时，请创建**包含问题编号的 PR**。
+
+## 贡献指南
+
+1. 请用友好的语气书写。
+
+2. **主动语态**总体上优于被动语态。主动语态中的句子会突出执行动作的人，而不是被动语态突出动作的接受者。
+
+3. 文档写作建议
+
+- 正确拼写产品名称 “TDengine”。 “TD” 用大写字母，“TD” 和 “engine” 之间没有空格 **（正确拼写：TDengine）**。
+- 在句号或其他标点符号后只留一个空格。
+
+4. 尽量**使用简单句**，而不是复杂句。
+
+## 给贡献者的礼品
+
+只要您是为 TDengine 做贡献的开发者，不管是代码贡献、修复 bug 或功能请求，还是文档更改，您都将会获得一份**特别的贡献者纪念品礼物**！
+
+<p align="left">
+  <img
+    src="docs/assets/contributing-cup.jpg"
+    alt=""
+    width="200"
+  />
+  <img
+    src="docs/assets/contributing-notebook.jpg"
+    alt=""
+    width="200"
+  />
+  <img
+    src="docs/assets/contributing-shirt.jpg"
+    alt=""
+    width="200"
+    />
+
+TDengine 社区致力于让更多的开发者理解和使用它。
+请填写**贡献者提交表**以选择您想收到的礼物。
+
+- [贡献者提交表](https://page.ma.scrmtech.com/form/index?pf_uid=27715_2095&id=12100)
+
+## 联系我们
+
+如果您有什么问题需要解决，或者有什么问题需要解答，可以添加微信：TDengineECO

CONTRIBUTING.md

 # Contributing
 
-We appreciate contributions from all developers. Feel free to follow us, fork the repository, report bugs and even submit your code on GitHub. However, we would like developers to follow our guides to contribute for better corporation. 
+We appreciate contributions from all developers. Feel free to follow us, fork the repository, report bugs, and even submit your code on GitHub. However, we would like developers to follow the guidelines in this document to ensure effective cooperation.
 
-## Report bugs
+## Reporting a bug
 
-Any users can report bugs to us through the [github issue tracker](https://github.com/taosdata/TDengine/issues). We appreciate a detailed description of the problem you met. It is better to provide the detailed steps on reproducing the bug. Otherwise, an appendix with log files generated by the bug is welcome.
+- Any users can report bugs to us through the **[GitHub issue tracker](https://github.com/taosdata/TDengine/issues)**. We would appreciate if you could provide **a detailed description** of the problem you encountered, including steps to reproduce it.
 
-## Read the contributor license agreement
+- Attaching log files caused by the bug is really appreciated.
 
-It is required to agree the Contributor Licence Agreement(CLA) before a user submitting his/her code patch. Follow the [TaosData CLA](https://www.taosdata.com/en/contributor/) link to read through the agreement. 
+## Guidelines for committing code
 
-## Submit your code
+- You must agree to the **Contributor License Agreement(CLA) before submitting your code patch**. Follow the **[TAOSData CLA](https://cla-assistant.io/taosdata/TDengine)** link to read through and sign the agreement. If you do not accept the agreement, your contributions cannot be accepted.
 
-Before submitting your code, make sure to [read the contributor license agreement](#read-the-contributor-license-agreement) beforehand. If you don't accept the aggreement, please stop submitting. Your submission means you have accepted the agreement. Your submission should solve an issue or add a feature registered in the [github issue tracker](https://github.com/taosdata/TDengine/issues). If no corresponding issue or feature is found in the issue tracker, please create one. When submitting your code to our repository, please create a pull request with the issue number included.
+- Please solve an issue or add a feature registered in the **[GitHub issue tracker](https://github.com/taosdata/TDengine/issues)**.
+- If no corresponding issue or feature is found in the issue tracker, please **create one**.
+- When submitting your code to our repository, please create a pull request with the **issue number** included.
+
+## Guidelines for communicating
+
+1. Please be **nice and polite** in the description.
+2. **Active voice is better than passive voice in general**. Sentences in the active voice will highlight who is performing the action rather than the recipient of the action highlighted by the passive voice.
+3. Documentation writing advice
+
+- Spell the product name "TDengine" correctly. "TD" is written in capital letters, and there is no space between "TD" and "engine" (**Correct spelling: TDengine**).
+- Please **capitalize the first letter** of every sentence.
+- Leave **only one space** after periods or other punctuation marks.
+- Use **American spelling**.
+- When possible, **use second person** rather than first person (e.g.“You are recommended to use a reverse proxy such as Nginx.” rather than “We recommend to use a reverse proxy such as Nginx.”).
+
+5. Use **simple sentences**, rather than complex sentences.
+
+## Gifts for the contributors
+
+Developers, as long as you contribute to TDengine, whether it's code contributions to fix bugs or feature requests, or documentation changes, **you are eligible for a very special Contributor Souvenir Gift!**
+
+**You can choose one of the following gifts:**
+
+<p align="left">
+  <img
+    src="docs/assets/contributing-cup.jpg"
+    alt=""
+    width="200"
+  />
+  <img
+    src="docs/assets/contributing-notebook.jpg"
+    alt=""
+    width="200"
+  />
+  <img
+    src="docs/assets/contributing-shirt.jpg"
+    alt=""
+    width="200"
+    />
+
+The TDengine community is committed to making TDengine accepted and used by more developers.
+
+Just fill out the **Contributor Submission Form** to choose your desired gift.
+
+- [Contributor Submission Form](https://page.ma.scrmtech.com/form/index?pf_uid=27715_2095&id=12100)
+
+## Contact us
+
+If you have any problems or questions that need help from us, please feel free to add our WeChat account: TDengineECO.

README.md

@@ -15,7 +15,6 @@
 [![Coverage Status](https://coveralls.io/repos/github/taosdata/TDengine/badge.svg?branch=develop)](https://coveralls.io/github/taosdata/TDengine?branch=develop)
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4201/badge)](https://bestpractices.coreinfrastructure.org/projects/4201)
 
-
 English | [简体中文](README-CN.md) | We are hiring, check [here](https://tdengine.com/careers)
 
 # What is TDengine？
@@ -42,7 +41,7 @@ For user manual, system design and architecture, please refer to [TDengine Docum
 
 At the moment, TDengine server supports running on Linux, Windows systems.Any OS application can also choose the RESTful interface of taosAdapter to connect the taosd service . TDengine supports X64/ARM64 CPU , and it will support MIPS64, Alpha64, ARM32, RISC-V and other CPU architectures in the future.
 
-You can choose to install through source code according to your needs, [container](https://docs.taosdata.com/get-started/docker/), [installation package](https://docs.taosdata.com/get-started/package/) or [Kubenetes](https://docs.taosdata.com/deployment/k8s/) to install. This quick guide only applies to installing from source.   
+You can choose to install through source code according to your needs, [container](https://docs.taosdata.com/get-started/docker/), [installation package](https://docs.taosdata.com/get-started/package/) or [Kubernetes](https://docs.taosdata.com/deployment/k8s/) to install. This quick guide only applies to installing from source.
 
 TDengine provide a few useful tools such as taosBenchmark (was named taosdemo) and taosdump. They were part of TDengine. By default, TDengine compiling does not include taosTools. You can use `cmake .. -DBUILD_TOOLS=true` to make them be compiled with TDengine.
 
@@ -58,7 +57,6 @@ sudo apt-get install -y gcc cmake build-essential git libssl-dev
 
 #### Install build dependencies for taosTools
 
-
 To build the [taosTools](https://github.com/taosdata/taos-tools) on Ubuntu/Debian, the following packages need to be installed.
 
 ```bash
@@ -82,14 +80,13 @@ sudo dnf install -y gcc gcc-c++ make cmake epel-release git openssl-devel
 
 #### Install build dependencies for taosTools on CentOS
 
-
 #### CentOS 7.9
 
 ```
 sudo yum install -y zlib-devel xz-devel snappy-devel jansson jansson-devel pkgconfig libatomic libstdc++-static openssl-devel
 ```
 
-#### CentOS 8/Rocky Linux 
+#### CentOS 8/Rocky Linux
 
 ```
 sudo yum install -y epel-release
@@ -100,14 +97,14 @@ sudo yum install -y zlib-devel xz-devel snappy-devel jansson jansson-devel pkgco
 
 Note: Since snappy lacks pkg-config support (refer to [link](https://github.com/google/snappy/pull/86)), it leads a cmake prompt libsnappy not found. But snappy still works well.
 
-If the powertools installation fails, you can try to use:
+If the PowerTools installation fails, you can try to use:
+
 ```
-sudo yum config-manager --set-enabled Powertools
+sudo yum config-manager --set-enabled powertools
 ```
 
 ### Setup golang environment
 
-
 TDengine includes a few components like taosAdapter developed by Go language. Please refer to golang.org official documentation for golang environment setup.
 
 Please use version 1.14+. For the user in China, we recommend using a proxy to accelerate package downloading.
@@ -125,7 +122,7 @@ cmake .. -DBUILD_HTTP=false
 
 ### Setup rust environment
 
-TDengine includes a few compoments developed by Rust language. Please refer to rust-lang.org official documentation for rust environment setup.
+TDengine includes a few components developed by Rust language. Please refer to rust-lang.org official documentation for rust environment setup.
 
 ## Get the source codes
 
@@ -136,7 +133,6 @@ git clone https://github.com/taosdata/TDengine.git
 cd TDengine
 ```
 
-
 You can modify the file ~/.gitconfig to use ssh protocol instead of https for better download speed. You will need to upload ssh public key to GitHub first. Please refer to GitHub official documentation for detail.
 
 ```
@@ -146,14 +142,12 @@ You can modify the file ~/.gitconfig to use ssh protocol instead of https for be
 
 ## Special Note
 
-
 [JDBC Connector](https://github.com/taosdata/taos-connector-jdbc)， [Go Connector](https://github.com/taosdata/driver-go)，[Python Connector](https://github.com/taosdata/taos-connector-python)，[Node.js Connector](https://github.com/taosdata/taos-connector-node)，[C# Connector](https://github.com/taosdata/taos-connector-dotnet) ，[Rust Connector](https://github.com/taosdata/taos-connector-rust) and [Grafana plugin](https://github.com/taosdata/grafanaplugin) has been moved to standalone repository.
 
 ## Build TDengine
 
 ### On Linux platform
 
-
 You can run the bash script `build.sh` to build both TDengine and taosTools including taosBenchmark and taosdump as below:
 
 ```bash
@@ -169,7 +163,6 @@ cmake .. -DBUILD_TOOLS=true
 make
 ```
 
-
 You can use Jemalloc as memory allocator instead of glibc:
 
 ```
@@ -237,7 +230,7 @@ After building successfully, TDengine can be installed by
 sudo make install
 ```
 
-Users can find more information about directories installed on the system in the [directory and files](https://docs.taosdata.com/reference/directory/) section.  
+Users can find more information about directories installed on the system in the [directory and files](https://docs.taosdata.com/reference/directory/) section.
 
 Installing from source code will also configure service management for TDengine.Users can also choose to [install from packages](https://docs.taosdata.com/get-started/package/) for it.
 
@@ -309,7 +302,7 @@ Query OK, 2 row(s) in set (0.001700s)
 
 ## Official Connectors
 
-TDengine provides abundant developing tools for users to develop on TDengine.  include C/C++、Java、Python、Go、Node.js、C# 、RESTful  ,Follow the links below to find your desired connectors and relevant documentation.
+TDengine provides abundant developing tools for users to develop on TDengine. Follow the links below to find your desired connectors and relevant documentation.
 
 - [Java](https://docs.taosdata.com/reference/connector/java/)
 - [C/C++](https://docs.taosdata.com/reference/connector/cpp/)