mirror of
https://github.com/apache/rocketmq.git
synced 2026-10-28 02:35:09 +08:00
32 lines
1.9 KiB
Markdown
32 lines
1.9 KiB
Markdown
## 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, as well as the surrounding [ecosystem](https://github.com/apache/rocketmq-externals) of integration tools that people use with RocketMQ.
|
|
|
|
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 [RIP](https://github.com/apache/rocketmq/wiki/RocketMQ-Improvement-Proposal) 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 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 SDK(C++\.Net\Php\Python\Go\Node.js)
|
|
#### RocketMQ Connectors
|
|
|
|
##### 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](style/rmq_checkstyle.xml), and at least 3 month update frequency
|
|
###### Deployability - We encourage you to deploy into [maven repository](http://search.maven.org/)
|