rocketmq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From vongosl...@apache.org
Subject incubator-rocketmq git commit: Polish the doc
Date Wed, 21 Dec 2016 14:26:19 GMT
Repository: incubator-rocketmq
Updated Branches:
  refs/heads/master 9ec7e26ed -> 8d7dd2b37


Polish the doc


Project: http://git-wip-us.apache.org/repos/asf/incubator-rocketmq/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-rocketmq/commit/8d7dd2b3
Tree: http://git-wip-us.apache.org/repos/asf/incubator-rocketmq/tree/8d7dd2b3
Diff: http://git-wip-us.apache.org/repos/asf/incubator-rocketmq/diff/8d7dd2b3

Branch: refs/heads/master
Commit: 8d7dd2b377a053901432f873b322197aa51a4f06
Parents: 9ec7e26
Author: vongosling <vongosling.fengj@alibaba-inc.com>
Authored: Wed Dec 21 22:23:56 2016 +0800
Committer: vongosling <vongosling.fengj@alibaba-inc.com>
Committed: Wed Dec 21 22:23:56 2016 +0800

----------------------------------------------------------------------
 CONTRIBUTING.md | 26 ++++++++++++++++++++------
 README.md       | 20 ++++++--------------
 2 files changed, 26 insertions(+), 20 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-rocketmq/blob/8d7dd2b3/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a3f3baa..f212787 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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.
\ No newline at end of file
+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/)

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq/blob/8d7dd2b3/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 9c72002..20119d4 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-## RocketMQ -- Alibaba's MQ [![Build Status](https://travis-ci.org/alibaba/RocketMQ.svg?branch=master)](https://travis-ci.org/alibaba/RocketMQ)
+## RocketMQ [![Build Status](https://travis-ci.org/alibaba/RocketMQ.svg?branch=master)](https://travis-ci.org/alibaba/RocketMQ)
 [![Maven Central](https://img.shields.io/badge/maven--center-stable--version-green.svg)](http://search.maven.org/#search%7Cga%7C1%7Ccom.alibaba.rocketmq)
 [![GitHub release](https://img.shields.io/badge/release-download-orange.svg)](https://github.com/alibaba/RocketMQ/releases)
 [![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
@@ -11,7 +11,7 @@ It offers a variety of features as follows:
 * Reliable FIFO and strict sequential messaging in the same queue
 * Long pull queue model,also support push consumption style
 * Million message accumulation ability in single queue
-* Over a variety of messaging protocols.such as JMS,MQTT,HTTP etc.
+* Over a variety of messaging protocols.such as JMS,MQTT etc.
 * Distributed high available deploy architecture, meets at least once message delivery semantics
 * Docker images for isolated testing and cloud Isolated clusters
 * Feature-rich administrative dashboard for configuration,metrics and monitoring [![Cloud
Charge](https://img.shields.io/badge/cloud-charge-red.svg)](https://www.aliyun.com/product/ons/?spm=5176.7960203.237031.135.67OdNO)
@@ -22,30 +22,22 @@ It offers a variety of features as follows:
 ----------
 
 ## Learn it & Contact us
-* Homepage: <https://github.com/alibaba/RocketMQ>
-* Mailing list: <https://groups.google.com/forum/?hl=en#!forum/rocketmq>
-* Documentation: <https://github.com/alibaba/RocketMQ/wiki>
-* Wiki: <https://github.com/alibaba/RocketMQ/wiki>
-* Issues: <https://github.com/alibaba/RocketMQ/issues>
+* Wiki: <https://cwiki.apache.org/confluence/display/ROCKETMQ/Apache+RocketMQ+Home>
+* Issues: <https://issues.apache.org/jira/browse/RocketMQ>
 * Ask: <http://stackoverflow.com/questions/tagged/rocketmq> or <https://www.quora.com/topic/RocketMQ>
 * [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/alibaba/RocketMQ?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
  
 
 ----------
 
-## How can I develop with RocketMQ?
-* [Download the latest release package](https://github.com/alibaba/RocketMQ/releases)
-* [Get the latest document & Who using RocketMQ](https://github.com/alibaba/RocketMQ/issues/1)
-* [`Using RocketMQ in Aliyun`](http://www.aliyun.com/product/ons)
+## RocketMQ Community
 * [`Docker images`](https://registry.hub.docker.com/u/vongosling/rocketmq/)
-* [Integrate with Alibaba JStorm](https://github.com/alibaba/jstorm)
-* [Integrate with Alibaba Canal](https://github.com/alibaba/canal)
 * [RocketMQ Community Projects](https://github.com/rocketmq)
 
 ----------
 
 ## Contributing
-We are always very happy to have contributions, whether for trivial cleanups,big new features
or other material rewards. more details see [here](https://github.com/alibaba/RocketMQ/wiki/How-to-donate)

+We are always very happy to have contributions, whether for trivial cleanups,big new features
or other material rewards. more details see [here](CONTRIBUTING.md) 
  
 ----------
 ## License


Mime
View raw message