From 98210c294cdfc89e9f968abed24f3d909d45380c Mon Sep 17 00:00:00 2001 From: IsaDSC <101098187+IsaDSC@users.noreply.github.com> Date: Mon, 27 Jun 2022 17:28:12 +0800 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 730bc33471..ce88a62aba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ We appreciate contributions from all developers. Feel free to follow us, fork th * 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. -* An appendix with log files generated by the bug is welcome. +* Attaching log files caused by the bug is really appreciated. ## Guidelines for committing code @@ -22,15 +22,15 @@ We appreciate contributions from all developers. Feel free to follow us, fork th ## Guidelines for communicating -1. Please write in **a friendly tone**. -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 +1. Please be **nice and polite** in the description. +3. **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. +4. 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 uses a reverse proxy such as Nginx.” rather than “We recommend to uses a reverse proxy such as Nginx.”). -4. Use **simple sentences**, rather than complex sentences. +* 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 @@ -58,7 +58,7 @@ Developers, as long as you contribute to TDengine, whether it's code contributio /> -The TDengine community is committed to making TDengine understood and used by more developers. +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. @@ -67,4 +67,4 @@ Just fill out the **Contributor Submission Form** to choose your desired gift. ## Contact us -If you have any problems that need to be solved, or any questions that need to be answered, you can add our WeChat account: TDengineECO +If you have any problems or questions that need help from us, please feel free to add our WeChat account: TDengineECO. -- GitLab