forked from apache/dubbo
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
20 changed files
with
178 additions
and
178 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,15 +9,15 @@ Before we accept a non-trivial patch or pull request we will need you to sign th | |
|
||
#### Mailing list | ||
|
||
The mailing list is the recommended way for discussing almost anything that related to Dubbo. Please refer to this [guide](https://github.com/apache/incubator-dubbo/wiki/Mailing-list-subscription-guide) for detailed documentation on how to subscribe. | ||
The mailing list is the recommended way for discussing almost anything that related to Dubbo. Please refer to this [guide](https://github.com/apache/dubbo/wiki/Mailing-list-subscription-guide) for detailed documentation on how to subscribe. | ||
|
||
- [dev@dubbo.incubator.apache.org](mailto:dev-subscribe@dubbo.incubator.apache.org): the develop mailing list, you can ask question here if you have encountered any problem when using or developing Dubbo. | ||
- [commits@dubbo.incubator.apache.org](mailto:commits-subscribe@dubbo.incubator.apache.org): all the commits will be sent to this mailing list. You can subscribe to it if you are interested in Dubbo's development. | ||
- [notifications@dubbo.incubator.apache.org](mailto:notifications-subscribe@dubbo.incubator.apache.org): all the Github [issue](https://github.com/apache/incubator-dubbo/issues) updates and [pull request](https://github.com/apache/incubator-dubbo/pulls) updates will be sent to this mailing list. | ||
- [[email protected]](mailto:[email protected]): the develop mailing list, you can ask question here if you have encountered any problem when using or developing Dubbo. | ||
- [[email protected]](mailto:[email protected]): all the commits will be sent to this mailing list. You can subscribe to it if you are interested in Dubbo's development. | ||
- [[email protected]](mailto:[email protected]): all the Github [issue](https://github.com/apache/dubbo/issues) updates and [pull request](https://github.com/apache/dubbo/pulls) updates will be sent to this mailing list. | ||
|
||
### Reporting issue | ||
|
||
Please follow the [template](https://github.com/apache/incubator-dubbo/issues/new?template=dubbo-issue-report-template.md) for reporting any issues. | ||
Please follow the [template](https://github.com/apache/dubbo/issues/new?template=dubbo-issue-report-template.md) for reporting any issues. | ||
|
||
### Code Conventions | ||
Our code style is almost in line with the standard java conventions (Popular IDE's default setting satisfy this), with the following additional restricts: | ||
|
@@ -46,23 +46,23 @@ This is a rough outline of what a contributor's workflow looks like: | |
* Make commits of logical units. | ||
* Make sure commit messages are in the proper format (see below). | ||
* Push changes in a topic branch to your forked repository. | ||
* Follow the checklist in the [pull request template](https://github.com/apache/incubator-dubbo/blob/master/PULL_REQUEST_TEMPLATE.md) | ||
* Follow the checklist in the [pull request template](https://github.com/apache/dubbo/blob/master/PULL_REQUEST_TEMPLATE.md) | ||
* Before you sending out the pull request, please sync your forked repository with remote repository, this will make your pull request simple and clear. See guide below: | ||
``` | ||
git remote add upstream [email protected]:apache/incubator-dubbo.git | ||
git remote add upstream [email protected]:apache/dubbo.git | ||
git fetch upstream | ||
git rebase upstream/master | ||
git checkout -b your_awesome_patch | ||
... add some work | ||
git push origin your_awesome_patch | ||
``` | ||
* Submit a pull request to apache/incubator-dubbo and wait for the reply. | ||
* Submit a pull request to apache/dubbo and wait for the reply. | ||
|
||
Thanks for contributing! | ||
|
||
### Code style | ||
|
||
We provide a template file [dubbo_codestyle_for_idea.xml](https://github.com/apache/incubator-dubbo/tree/master/codestyle/dubbo_codestyle_for_idea.xml) for IntelliJ idea, you can import it to you IDE. | ||
We provide a template file [dubbo_codestyle_for_idea.xml](https://github.com/apache/dubbo/tree/master/codestyle/dubbo_codestyle_for_idea.xml) for IntelliJ idea, you can import it to you IDE. | ||
If you use Eclipse you can config manually by referencing the same file. | ||
|
||
**NOTICE** | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,18 @@ | ||
# Apache Dubbo Project | ||
|
||
[](https://travis-ci.org/apache/incubator-dubbo) | ||
[](https://codecov.io/gh/apache/incubator-dubbo) | ||
[](https://travis-ci.org/apache/dubbo) | ||
[](https://codecov.io/gh/apache/dubbo) | ||
 | ||
 | ||
[](http://isitmaintained.com/project/apache/incubator-dubbo "Average time to resolve an issue") | ||
[](http://isitmaintained.com/project/apache/incubator-dubbo "Percentage of issues still open") | ||
[](https://twitter.com/intent/tweet?text=Apache%20Dubbo%20(incubating)%20is%20a%20high-performance%2C%20java%20based%2C%20open%20source%20RPC%20framework.&url=http://dubbo.incubator.apache.org/&via=ApacheDubbo&hashtags=rpc,java,dubbo,micro-service) | ||
[](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 [official site](http://dubbo.apache.org) for quick start and documentations, as well as [Wiki](https://github.com/apache/incubator-dubbo/wiki) for news, FAQ, and release notes. | ||
Apache Dubbo is a high-performance, Java based open source RPC framework. Please visit [official site](http://dubbo.apache.org) for quick start and documentations, as well as [Wiki](https://github.com/apache/dubbo/wiki) for news, FAQ, and release notes. | ||
|
||
We are now collecting dubbo user info in order to help us to improve Dubbo better, pls. kindly help us by providing yours on [issue#1012: Wanted: who's using dubbo](https://github.com/apache/incubator-dubbo/issues/1012), thanks :) | ||
We are now collecting dubbo user info in order to help us to improve Dubbo better, pls. kindly help us by providing yours on [issue#1012: Wanted: who's using dubbo](https://github.com/apache/dubbo/issues/1012), thanks :) | ||
|
||
## Architecture | ||
|
||
|
@@ -29,14 +29,14 @@ We are now collecting dubbo user info in order to help us to improve Dubbo bette | |
|
||
## Getting started | ||
|
||
The following code snippet comes from [Dubbo Samples](https://github.com/apache/incubator-dubbo-samples/tree/master/dubbo-samples-api). You may clone the sample project and step into `dubbo-samples-api` sub directory before read on. | ||
The following code snippet comes from [Dubbo Samples](https://github.com/apache/dubbo-samples/tree/master/dubbo-samples-api). You may clone the sample project and step into `dubbo-samples-api` sub directory before read on. | ||
|
||
```bash | ||
# git clone https://github.com/apache/incubator-dubbo-samples.git | ||
# cd incubator-dubbo-samples/dubbo-samples-api | ||
# git clone https://github.com/apache/dubbo-samples.git | ||
# cd dubbo-samples/dubbo-samples-api | ||
``` | ||
|
||
There's a [README](https://github.com/apache/incubator-dubbo-samples/tree/master/dubbo-samples-api/README.md) file under `dubbo-samples-api` directory. Read it and try this sample out by following the instructions. | ||
There's a [README](https://github.com/apache/dubbo-samples/tree/master/dubbo-samples-api/README.md) file under `dubbo-samples-api` directory. Read it and try this sample out by following the instructions. | ||
|
||
### Maven dependency | ||
|
||
|
@@ -70,7 +70,7 @@ public interface GreetingService { | |
} | ||
``` | ||
|
||
*See [api/GreetingService.java](https://github.com/apache/incubator-dubbo-samples/blob/master/dubbo-samples-api/src/main/java/org/apache/dubbo/samples/api/GreetingsService.java) on GitHub.* | ||
*See [api/GreetingService.java](https://github.com/apache/dubbo-samples/blob/master/dubbo-samples-api/src/main/java/org/apache/dubbo/samples/api/GreetingsService.java) on GitHub.* | ||
|
||
### Implement service interface for the provider | ||
|
||
|
@@ -87,7 +87,7 @@ public class GreetingServiceImpl implements GreetingService { | |
} | ||
``` | ||
|
||
*See [provider/GreetingServiceImpl.java](https://github.com/apache/incubator-dubbo-samples/blob/master/dubbo-samples-api/src/main/java/org/apache/dubbo/samples/server/GreetingsServiceImpl.java) on GitHub.* | ||
*See [provider/GreetingServiceImpl.java](https://github.com/apache/dubbo-samples/blob/master/dubbo-samples-api/src/main/java/org/apache/dubbo/samples/server/GreetingsServiceImpl.java) on GitHub.* | ||
|
||
### Start service provider | ||
|
||
|
@@ -115,7 +115,7 @@ public class Application { | |
} | ||
``` | ||
|
||
*See [provider/Application.java](https://github.com/apache/incubator-dubbo-samples/blob/master/dubbo-samples-api/src/main/java/org/apache/dubbo/samples/server/Application.java) on GitHub.* | ||
*See [provider/Application.java](https://github.com/apache/dubbo-samples/blob/master/dubbo-samples-api/src/main/java/org/apache/dubbo/samples/server/Application.java) on GitHub.* | ||
|
||
### Build and run the provider | ||
|
||
|
@@ -155,7 +155,7 @@ public class Application { | |
|
||
The consumer will print out `Hello world` on the screen. | ||
|
||
*See [consumer/Application.java](https://github.com/apache/incubator-dubbo-samples/blob/master/dubbo-samples-api/src/main/java/org/apache/dubbo/samples/client/Application.java) on GitHub.* | ||
*See [consumer/Application.java](https://github.com/apache/dubbo-samples/blob/master/dubbo-samples-api/src/main/java/org/apache/dubbo/samples/client/Application.java) on GitHub.* | ||
|
||
### Next steps | ||
|
||
|
@@ -175,35 +175,35 @@ If you want to try out the cutting-edge features, you can built with the followi | |
## 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/incubator-dubbo/wiki/Mailing-list-subscription-guide) | ||
* 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/incubator-dubbo/issues/new?template=dubbo-issue-report-template.md) | ||
* 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) | ||
|
||
## Contributing | ||
|
||
See [CONTRIBUTING](https://github.com/apache/incubator-dubbo/blob/master/CONTRIBUTING.md) for details on submitting patches and the contribution workflow. | ||
See [CONTRIBUTING](https://github.com/apache/dubbo/blob/master/CONTRIBUTING.md) for details on submitting patches and the contribution workflow. | ||
|
||
### How can I contribute? | ||
|
||
* Take a look at issues with tag called [`Good first issue`](https://github.com/apache/incubator-dubbo/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) or [`Help wanted`](https://github.com/apache/incubator-dubbo/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). | ||
* Join the discussion on mailing list, subscription [guide](https://github.com/apache/incubator-dubbo/wiki/Mailing-list-subscription-guide). | ||
* Answer questions on [issues](https://github.com/apache/incubator-dubbo/issues). | ||
* Fix bugs reported on [issues](https://github.com/apache/incubator-dubbo/issues), and send us pull request. | ||
* Review the existing [pull request](https://github.com/apache/incubator-dubbo/pulls). | ||
* Improve the [website](https://github.com/apache/incubator-dubbo-website), typically we need | ||
* Take a look at issues with tag called [`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 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 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 about how Dubbo is being used in enterprise system. | ||
* Improve the [dubbo-admin/dubbo-monitor](https://github.com/apache/incubator-dubbo-admin). | ||
* Improve the [dubbo-admin/dubbo-monitor](https://github.com/apache/dubbo-admin). | ||
* Contribute to the projects listed in [ecosystem](https://github.com/dubbo). | ||
* Any form of contribution that is not mentioned above. | ||
* If you would like to contribute, please send an email to [email protected] to let us know! | ||
|
||
## Reporting bugs | ||
|
||
Please follow the [template](https://github.com/apache/incubator-dubbo/issues/new?template=dubbo-issue-report-template.md) for reporting any issues. | ||
Please follow the [template](https://github.com/apache/dubbo/issues/new?template=dubbo-issue-report-template.md) for reporting any issues. | ||
|
||
## Reporting a security vulnerability | ||
|
||
|
@@ -212,19 +212,19 @@ Please report security vulnerability to [us](mailto:[email protected]) p | |
## Dubbo ecosystem | ||
|
||
* [Dubbo Ecosystem Entry](https://github.com/dubbo) - 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/incubator-dubbo-website) - Apache Dubbo official website | ||
* [Dubbo Samples](https://github.com/apache/incubator-dubbo-samples) - samples for Apache Dubbo | ||
* [Dubbo Spring Boot](https://github.com/apache/incubator-dubbo-spring-boot-project) - Spring Boot Project for Dubbo | ||
* [Dubbo Admin](https://github.com/apache/incubator-dubbo-admin) - The reference implementation for Dubbo admin | ||
* [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 | ||
|
||
#### Language | ||
|
||
* [Node.js](https://github.com/dubbo/dubbo2.js) | ||
* [Python](https://github.com/dubbo/dubbo-client-py) | ||
* [PHP](https://github.com/dubbo/dubbo-php-framework) | ||
* [Node.js](https://github.com/apache/dubbo-js) | ||
* [Python](https://github.com/apache/dubbo-client-py) | ||
* [PHP](https://github.com/apache/dubbo-php-framework) | ||
* [Go](https://github.com/dubbo/dubbo-go) | ||
* [Erlang](https://github.com/apache/incubator-dubbo-erlang) | ||
* [Erlang](https://github.com/apache/dubbo-erlang) | ||
|
||
## License | ||
|
||
Apache Dubbo is under the Apache 2.0 license. See the [LICENSE](https://github.com/apache/incubator-dubbo/blob/master/LICENSE) file for details. | ||
Apache Dubbo is under the Apache 2.0 license. See the [LICENSE](https://github.com/apache/dubbo/blob/master/LICENSE) file for details. |
Oops, something went wrong.