Browse Source

docs: update README.md & README_EN.md (#1805)

* docs: update README.md

* docs: update README.md

* docs: update README.md

* docs: update README.md
peixinyu 3 years ago
parent
commit
5f96976645
2 changed files with 36 additions and 7 deletions
  1. 18 4
      README.md
  2. 18 3
      README_EN.md

+ 18 - 4
README.md

@@ -183,15 +183,29 @@ NutUI 已经投入了我们的生产环境中使用,业界也在广泛地使
 
 ## 参与共建
 
-请参考 [《贡献指南》](https://nutui.jd.com/#/zh-CN/guide/contributing),参与共建提 [PR](https://github.com/jdf2e/nutui/pulls)
+#### NutUI 社区共建倡议
 
-> 非常欢迎社区开发者为 NutUI 贡献代码,在贡献之前请先阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md),[《如何有效报告bug》](https://www.chiark.greenend.org.uk/~sgtatham/bugs-cn.html),[《NutUI 邀您共建》](https://jelly.jd.com/article/6320528b92d94a0068685525) 能够更容易的理解和获得帮助。
+[NutUI 邀您共建,Contributor 您好](https://github.com/jdf2e/nutui/issues/1789)
 
-感谢以下所有给 NutUI 贡献过代码的 [开发者](https://github.com/jdf2e/nutui/graphs/contributors)。
+#### 为 NutUI 贡献代码
+
+NutUI 的共建方向主要分为:解决 issue、修复 bug、新增组件、增加国际化、UI 定制、平台适配、跨端扩展等。
+
+欢迎社区开发者参与共建,在贡献您的代码之前请先阅读 [《NutUI 贡献指南》](https://github.com/jdf2e/nutui/issues/1671)。
+
+## 问题反馈与建议
+
+[给 NutUI 提 Issue](https://nutui.jd.com/nutui-issue-helper/?repo=jdf2e/nutui&lang=zh-cn)
+
+> 在反馈问题之前,推荐阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)、[《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545)和[《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html),这样您能够更容易获得理解和帮助。
+
+[参与 NutUI 社区讨论](https://github.com/jdf2e/nutui/discussions)
+
+如果您有任何想法、疑问或建议,都可以参与社区讨论分享您的观点。
 
 ## 贡献者们
 
-感谢以下小伙伴们为 NutUI 发展做出的贡献:
+感谢以下所有给 NutUI 贡献过代码的 [开发者](https://github.com/jdf2e/nutui/graphs/contributors)。
 
 <a href="https://github.com/jdf2e/nutui/graphs/contributors">
   <img src="https://opencollective.com/nutui/contributors.svg?width=890&button=false" alt="contributors">

+ 18 - 3
README_EN.md

@@ -180,12 +180,27 @@ NutUI has been used in our production environment, and widely used in the indust
 | [NutUI Vue](https://github.com/jdf2e/nutui/issues) | <img src="https://storage.360buyimg.com/nutui-static/image/wx-code.png" width="100" /> Reply 'NutUI' after following | 82957939
 | [NutUI x Taro](https://github.com/jdf2e/nutui/issues) | <img src="https://camo.githubusercontent.com/db4276b4ee4b443158195e943e9e678cb4d2afb7580f70d4d817ef0a90413aec/687474703a2f2f73746f726167652e333630627579696d672e636f6d2f7461726f2d6a642d636f6d2f7374617469632f636f6e746163745f7461726f5f6e757475695f71722e706e67" width="100" /> Reply 'NutUI' after following | 1022545110 |
 
-
 ## Join Us
 
-Please read [*Developer Contributing Guide*](https://nutui.jd.com/#/en-US/guide/contributing) before you create a [Pull Request](https://github.com/jdf2e/nutui/pulls).
+#### NutUI Community
+
+[*Welcome To NutUI  Community*](https://github.com/jdf2e/nutui/issues/1789)
+
+#### Contribute to NutUI
+
+There are some choices of contributing to NutUI as follows, solving issues, fixing bugs, adding new components, i18n, UI customization, platform and cross-end adaptation, etc.
+
+You are very welcome to contribute code to NutUI. Before your pull requests, please read [*NutUI Developer Contributing Guide*](https://github.com/jdf2e/nutui/issues/1671).
+
+## Issue & Discussion
+
+[Report issues to NutUI](https://nutui.jd.com/nutui-issue-helper/?repo=jdf2e/nutui&lang=en)
+
+> It is highly recommended to read [*How To Ask Questions The Smart Way*](http://www.catb.org/~esr/faqs/smart-questions.html), [*How To Ask Questions Of GitHub Community*](https://github.com/seajs/seajs/issues/545) and [*How to Report Bugs Effectively*](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html), then you can get understanding and help more easily.
+
+[NutUI Discussion](https://github.com/jdf2e/nutui/discussions)
 
-> You are very welcome to contribute code to NutUI. It is highly recommended to read [*How To Ask Questions The Smart Way*](http://www.catb.org/~esr/faqs/smart-questions.html), [*How to Report Bugs Effectively*](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html) and [*Welcome to NutUI  community*](https://jelly.jd.com/article/6320528b92d94a0068685525), then you can get understanding and help more easily.
+If you have any ideas, questions or suggestions, you can share your opinions here.
 
 ## Contributors