This is an automated email from the ASF dual-hosted git repository.
liujun pushed a commit to branch 3.2
in repository https://gitbox.apache.org/repos/asf/dubbo.git
The following commit(s) were added to refs/heads/3.2 by this push:
new d4a1e0d9bb Readme update (#13851)
d4a1e0d9bb is described below
commit d4a1e0d9bbd3ba65a1e3a3eaf6f68b9037c33030
Author: Albumen Kevin <[email protected]>
AuthorDate: Thu Mar 7 11:56:20 2024 +0800
Readme update (#13851)
---
README.md | 80 ++++++++++++++++++++++++++++++++++++++++++---------------------
1 file changed, 53 insertions(+), 27 deletions(-)
diff --git a/README.md b/README.md
index 8137d2a8d4..975deece80 100644
--- a/README.md
+++ b/README.md
@@ -6,13 +6,10 @@
[](http://isitmaintained.com/project/apache/dubbo
"Average time to resolve an issue")
[](http://isitmaintained.com/project/apache/dubbo
"Percentage of issues still open")
-[](https://twitter.com/intent/tweet?text=Apache%20Dubbo%20is%20a%20high-performance%2C%20java%20based%2C%20open%20source%20RPC%20framework.&url=http://dubbo.apache.org/&via=ApacheDubbo&hashtags=rpc,java,dubbo,micro-service)
-[](https://twitter.com/intent/follow?screen_name=ApacheDubbo)
-[](https://gitter.im/alibaba/dubbo?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
Apache Dubbo is a high-performance, Java-based open-source RPC framework.
Please visit the [official site](http://dubbo.apache.org) for the quick start
guide and documentation, as well as the
[wiki](https://github.com/apache/dubbo/wiki) for news, FAQ, and release notes.
-We are now collecting Dubbo user info to help us to improve Dubbo further.
Kindly support us by providing your usage information on [issue#9436: Wanted:
who's using dubbo](https://github.com/apache/dubbo/issues/9436), thanks :)
+We are now collecting Dubbo user info to help us to improve Dubbo further.
Kindly support us by providing your usage information on [Wanted: who's using
dubbo](https://github.com/apache/dubbo/discussions/13842), thanks :)
## Architecture
@@ -186,34 +183,55 @@ To avoid intermittent test failures (i.e., flaky tests),
it is recommended to ha
* Minimum of 2CPUs.
* Minimum of 2Gb of RAM.
-## Contact
+### How does the Dubbo Community collaborate?
-* Mailing list:
- * dev list: for dev/user discussion.
[subscribe](mailto:[email protected]),
[unsubscribe](mailto:[email protected]),
[archive](https://lists.apache.org/[email protected]),
[guide](https://github.com/apache/dubbo/wiki/Mailing-list-subscription-guide)
+The Dubbo Community primarily communicates on GitHub through issues,
discussions, and pull requests.
-* Bugs:
[Issues](https://github.com/apache/dubbo/issues/new?template=dubbo-issue-report-template.md)
-* Gitter: [Gitter channel](https://gitter.im/alibaba/dubbo)
-* Twitter: [@ApacheDubbo](https://twitter.com/ApacheDubbo)
+- Issues: We use issues to track bugs and tasks. Any **work-related** item is
associated with an issue.
+- Discussions: We use discussions for questions, early proposals, and
announcements. Any **idea-related** item is associated with a discussion.
+- Pull Requests: We use pull requests to merge a set of changes from
contributors into Dubbo.
+
+We have also implemented [a project
board](https://github.com/orgs/apache/projects/337) to monitor all the items.
+
+Any essential changes should be discussed on the mailing list before they
happen.
+
+### Seeking for help
+
+If you have questions such as:
+
+- What is Dubbo?
+- How do I use Dubbo?
+- Why did an unexpected result occur?
+
+Please start a discussion at https://github.com/apache/dubbo/discussions.
-## Contributing
+However, if you encounter the following situations:
-See
[CONTRIBUTING](https://github.com/apache/dubbo/blob/master/CONTRIBUTING.md) for
details on submitting patches and the contribution workflow.
+- You're certain there's a bug that Dubbo needs to fix,
+- You believe a feature could be enhanced,
+- You have a detailed proposal for improving Dubbo,
-### How can I contribute?
+Please open an issue at https://github.com/apache/dubbo/issues.
-* Take a look at issues with tags marked [`Good first
issue`](https://github.com/apache/dubbo/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
or [`Help
wanted`](https://github.com/apache/dubbo/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).
-* Join the discussion on the mailing list, subscription
[guide](https://github.com/apache/dubbo/wiki/Mailing-list-subscription-guide).
-* Answer questions on [issues](https://github.com/apache/dubbo/issues).
-* Fix bugs reported on [issues](https://github.com/apache/dubbo/issues), and
send us a pull request.
-* Review the existing [pull request](https://github.com/apache/dubbo/pulls).
-* Improve the [website](https://github.com/apache/dubbo-website), typically we
need
- * blog post
- * translation on documentation
- * use cases around the integration of Dubbo in enterprise systems.
-* Improve the
[dubbo-admin/dubbo-monitor](https://github.com/apache/dubbo-admin).
-* Contribute to the projects listed in [ecosystem](https://github.com/dubbo).
-* Other forms of contribution not explicitly enumerated above.
-* If you would like to contribute, please send an email to
[email protected] to let us know!
+To ask effective questions, we recommend reading **[How To Ask Questions The
Smart
Way](https://github.com/selfteaching/How-To-Ask-Questions-The-Smart-Way/blob/master/How-To-Ask-Questions-The-Smart-Way.md)**
first.
+
+### Contribution
+
+- Browse the "help wanted" tasks in the [Dubbo project
board](https://github.com/orgs/apache/projects/337).
+- Participate in discussions on the mailing list. See the subscription
[guide](https://github.com/apache/dubbo/wiki/Mailing-list-subscription-guide).
+- Respond to queries in the
[discussions](https://github.com/apache/dubbo/issues).
+- Resolve bugs reported in [issues](https://github.com/apache/dubbo/issues)
and send us a pull request.
+- Review existing [pull requests](https://github.com/apache/dubbo/pulls).
+- Enhance the [website](https://github.com/apache/dubbo-website). We typically
need:
+ - Blog posts
+ - Translations for documentation
+ - Use cases showcasing Dubbo integration in enterprise systems.
+- Improve the [dubbo-admin](https://github.com/apache/dubbo-admin).
+- Contribute to the projects listed in the
[ecosystem](https://github.com/apache/?q=dubbo&type=all&language=&sort=).
+- Any other forms of contribution not listed above are also welcome.
+- If you're interested in contributing, please send an email to
[[email protected]](mailto:[email protected]) to let us know!
+
+For further details, please refer our
[guide](https://github.com/apache/dubbo/blob/master/CONTRIBUTING.md) about how
to contribute Dubbo.
## Reporting bugs
@@ -223,12 +241,20 @@ Please follow the
[template](https://github.com/apache/dubbo/issues/new?template
Please report security vulnerabilities to
[us](mailto:[email protected]) privately.
+## Contact
+
+* Mailing list:
+ * dev list: for dev/user discussion.
[subscribe](mailto:[email protected]),
[unsubscribe](mailto:[email protected]),
[archive](https://lists.apache.org/[email protected]),
[guide](https://github.com/apache/dubbo/wiki/Mailing-list-subscription-guide)
+
+* Bugs:
[Issues](https://github.com/apache/dubbo/issues/new?template=dubbo-issue-report-template.md)
+* Gitter: [Gitter channel](https://gitter.im/alibaba/dubbo)
+* Twitter: [@ApacheDubbo](https://twitter.com/ApacheDubbo)
+
## Dubbo ecosystem
* [Dubbo Ecosystem
Entry](https://github.com/apache?utf8=%E2%9C%93&q=dubbo&type=&language=) - A
GitHub group `dubbo` to gather all Dubbo relevant projects not appropriate in
[apache](https://github.com/apache) group yet
* [Dubbo Website](https://github.com/apache/dubbo-website) - Apache Dubbo
official website
* [Dubbo Samples](https://github.com/apache/dubbo-samples) - samples for
Apache Dubbo
-* [Dubbo Spring Boot](https://github.com/apache/dubbo-spring-boot-project) -
Spring Boot Project for Dubbo
* [Dubbo Admin](https://github.com/apache/dubbo-admin) - The reference
implementation for Dubbo admin
* [Dubbo Awesome](https://github.com/apache/dubbo-awesome) - Dubbo's slides
and video links in Meetup
