forked from apache/rocketmq
-
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
vongosling
committed
Dec 21, 2016
1 parent
9ec7e26
commit 8d7dd2b
Showing
2 changed files
with
26 additions
and
20 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,31 @@ | ||
## How To Contribute | ||
|
||
We are always very happy to have contributions, whether for trivial cleanups or big new features. | ||
We want to have high quality, well documented codes for each programming language. These, as well as the surrounding [ecosystem](https://github.com/rocketmq) of integration tools that people use with RocketMQ, are critical aspects of the project. | ||
We want to have high quality, well documented codes for each programming language, as well as the surrounding [ecosystem](https://github.com/rocketmq) of integration tools that people use with RocketMQ. | ||
|
||
Nor is code the only way to contribute to the project. We strongly value documentation and gladly accept improvements to the documentation. | ||
Nor is code the only way to contribute to the project. We strongly value documentation, integration with other project, and gladly accept improvements for these aspects. | ||
|
||
## Contributing code | ||
|
||
To submit a change for inclusion, please do the following: | ||
#### If the change is non-trivial please include some unit tests that cover the new functionality. | ||
#### If you are introducing a completely new feature or API it is a good idea to start a wiki and get consensus on the basic design first. | ||
#### It is our job to follow up on patches in a timely fashion. Nag us if we aren't doing our job (sometimes we drop things). | ||
####If the change is non-trivial please include some unit tests that cover the new functionality. | ||
####If you are introducing a completely new feature or API it is a good idea to start a wiki and get consensus on the basic design first. | ||
####It is our job to follow up on patches in a timely fashion. Nag us if we aren't doing our job (sometimes we drop things). | ||
|
||
## Becoming a Committer | ||
|
||
We are always interested in adding new contributors. What we look for a series of contributions, good taste, and an ongoing interest in the project. If you are interested in becoming a committer, let one of the existing committers know and they can help guide you through the process. | ||
We are always interested in adding new contributors. What we look for are series of contributions, good taste and ongoing interest in the project. If you are interested in becoming a committer, please let one of the existing committers know and they can help you walk through the process. | ||
|
||
Nowadays,we have several important contribution points: | ||
#### Wiki & JavaDoc | ||
#### RocketMQ Console | ||
#### RocketMQ SDK(C++\.Net\Php\Python\Go\Node.js) | ||
#### RocketMQ MySQL(Oracle\PostgreSQL\Redis\MongoDB\HBase\MSSQL) Replicator | ||
|
||
##### Prerequisite | ||
If you want to contribute the above listing points, you must abide our some prerequisites: | ||
|
||
###### Readability - API must have Javadoc,some very important methods also must have javadoc | ||
###### Testability - 80% above unit test coverage about main process | ||
###### Maintainability - Comply with our [checkstyle spec](checkstyle/checkstyle.xml),and at least 3 month update frequency | ||
###### Deployability - We encourage you to deploy into [maven repository](http://search.maven.org/) |
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