incubator-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lolli...@apache.org
Subject [2/2] incubator-rocketmq-site git commit: Add code guidelines
Date Thu, 29 Dec 2016 05:38:35 GMT
Add code guidelines


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

Branch: refs/heads/master
Commit: 3cf041e269122c04d2094479b8576f4629925ab0
Parents: 2e6e3f6
Author: vongosling <vongosling @apache.org>
Authored: Thu Dec 29 11:24:34 2016 +0800
Committer: lollipop <lollipop@apache.org>
Committed: Thu Dec 29 13:36:36 2016 +0800

----------------------------------------------------------------------
 _data/navigation.yml                            |   2 +
 _docs/07-code-guidelines.md                     |  29 +
 assets/images/code_guidelines/author-tag.png    | Bin 0 -> 42774 bytes
 assets/images/code_guidelines/codestyle.png     | Bin 0 -> 76123 bytes
 .../images/code_guidelines/copyright-choose.png | Bin 0 -> 76573 bytes
 assets/images/code_guidelines/copyright.png     | Bin 0 -> 125994 bytes
 content/archive-layout-with-content/index.html  |  14 +
 .../images/code_guidelines/author-tag.png       | Bin 0 -> 42774 bytes
 .../assets/images/code_guidelines/codestyle.png | Bin 0 -> 76123 bytes
 .../images/code_guidelines/copyright-choose.png | Bin 0 -> 76573 bytes
 .../assets/images/code_guidelines/copyright.png | Bin 0 -> 125994 bytes
 content/collection-archive/index.html           |  21 +
 content/docs/cli-admin-tool/index.html          |  12 +-
 content/docs/cluster-deployment/index.html      |  12 +-
 content/docs/code-guidelines/index.html         | 534 +++++++++++++++++++
 content/docs/core-concept/index.html            |  12 +-
 content/docs/motivation/index.html              |  12 +-
 content/docs/pull-request/index.html            |  23 +-
 content/docs/quick-start/index.html             |  12 +-
 content/feed.xml                                |   2 +-
 content/sitemap.xml                             |   6 +
 21 files changed, 673 insertions(+), 18 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/_data/navigation.yml
----------------------------------------------------------------------
diff --git a/_data/navigation.yml b/_data/navigation.yml
index a17008d..925f81f 100644
--- a/_data/navigation.yml
+++ b/_data/navigation.yml
@@ -29,6 +29,8 @@ docs:
         url: /docs/cluster-deployment/
   - title: Contributor Guide
     children:
+      - title: "Code Guidelines"
+        url: /docs/code-guidelines/
       - title: "Best Practice in PR"
         url: /docs/pull-request/
   - title: Developer Guide

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/_docs/07-code-guidelines.md
----------------------------------------------------------------------
diff --git a/_docs/07-code-guidelines.md b/_docs/07-code-guidelines.md
new file mode 100644
index 0000000..b87dc3d
--- /dev/null
+++ b/_docs/07-code-guidelines.md
@@ -0,0 +1,29 @@
+---
+title: "Coding Guidelines"
+permalink: /docs/code-guidelines/
+excerpt: "Apache RocketMQ Coding Guidelines"
+modified: 2016-12-29T15:01:43-04:00
+---
+
+{% include toc %}
+
+# Introduction
+This document describes formatting rules and guidelines for software source code. Note that
this document does not cover best programming practices or techniques. It is solely concentrating
on source code formatting and conventions.
+
+Studies have shown that 80% of development time spent on software maintenance which involves
software source code understanding, refactoring and support. Established and enforced code
formatting rules and guidelines improve source code readability, promote team code ownership,
allow engineers understand new code more quickly and thorough as well as simplify maintenance.
+
+# Code template for idea
+## Import code style 
+![codestyle](/assets/images/code_guidelines/codestyle.png)
+
+## Import copyright
+### 1. Import from directory style -> copyright -> Apache.xml
+![copyright](/assets/images/code_guidelines/copyright.png)
+### 2. Choose Apache copyright
+![copyright-choose](/assets/images/code_guidelines/copyright-choose.png)
+
+
+## Remove author javadoc tag
+![author-javadoc-tag](/assets/images/code_guidelines/author-tag.png)
+
+

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/assets/images/code_guidelines/author-tag.png
----------------------------------------------------------------------
diff --git a/assets/images/code_guidelines/author-tag.png b/assets/images/code_guidelines/author-tag.png
new file mode 100644
index 0000000..61344cf
Binary files /dev/null and b/assets/images/code_guidelines/author-tag.png differ

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/assets/images/code_guidelines/codestyle.png
----------------------------------------------------------------------
diff --git a/assets/images/code_guidelines/codestyle.png b/assets/images/code_guidelines/codestyle.png
new file mode 100644
index 0000000..5136e6e
Binary files /dev/null and b/assets/images/code_guidelines/codestyle.png differ

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/assets/images/code_guidelines/copyright-choose.png
----------------------------------------------------------------------
diff --git a/assets/images/code_guidelines/copyright-choose.png b/assets/images/code_guidelines/copyright-choose.png
new file mode 100644
index 0000000..044130f
Binary files /dev/null and b/assets/images/code_guidelines/copyright-choose.png differ

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/assets/images/code_guidelines/copyright.png
----------------------------------------------------------------------
diff --git a/assets/images/code_guidelines/copyright.png b/assets/images/code_guidelines/copyright.png
new file mode 100644
index 0000000..f653adb
Binary files /dev/null and b/assets/images/code_guidelines/copyright.png differ

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/content/archive-layout-with-content/index.html
----------------------------------------------------------------------
diff --git a/content/archive-layout-with-content/index.html b/content/archive-layout-with-content/index.html
index cf386a4..42a35f2 100644
--- a/content/archive-layout-with-content/index.html
+++ b/content/archive-layout-with-content/index.html
@@ -640,6 +640,20 @@
     
     <h2 class="archive__item-title" itemprop="headline">
       
+        <a href="/docs/code-guidelines/" rel="permalink">Coding Guidelines</a>
+      
+    </h2>
+    
+    <p class="archive__item-excerpt" itemprop="description">Apache RocketMQ Coding
Guidelines
+</p>
+  </article>
+</div>
+
+<div class="list__item">
+  <article class="archive__item" itemscope="" itemtype="http://schema.org/CreativeWork">
+    
+    <h2 class="archive__item-title" itemprop="headline">
+      
         <a href="/404.html" rel="permalink">Page Not Found</a>
       
     </h2>

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/content/assets/images/code_guidelines/author-tag.png
----------------------------------------------------------------------
diff --git a/content/assets/images/code_guidelines/author-tag.png b/content/assets/images/code_guidelines/author-tag.png
new file mode 100644
index 0000000..61344cf
Binary files /dev/null and b/content/assets/images/code_guidelines/author-tag.png differ

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/content/assets/images/code_guidelines/codestyle.png
----------------------------------------------------------------------
diff --git a/content/assets/images/code_guidelines/codestyle.png b/content/assets/images/code_guidelines/codestyle.png
new file mode 100644
index 0000000..5136e6e
Binary files /dev/null and b/content/assets/images/code_guidelines/codestyle.png differ

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/content/assets/images/code_guidelines/copyright-choose.png
----------------------------------------------------------------------
diff --git a/content/assets/images/code_guidelines/copyright-choose.png b/content/assets/images/code_guidelines/copyright-choose.png
new file mode 100644
index 0000000..044130f
Binary files /dev/null and b/content/assets/images/code_guidelines/copyright-choose.png differ

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/content/assets/images/code_guidelines/copyright.png
----------------------------------------------------------------------
diff --git a/content/assets/images/code_guidelines/copyright.png b/content/assets/images/code_guidelines/copyright.png
new file mode 100644
index 0000000..f653adb
Binary files /dev/null and b/content/assets/images/code_guidelines/copyright.png differ

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/content/collection-archive/index.html
----------------------------------------------------------------------
diff --git a/content/collection-archive/index.html b/content/collection-archive/index.html
index 013ce45..213ad44 100644
--- a/content/collection-archive/index.html
+++ b/content/collection-archive/index.html
@@ -414,6 +414,27 @@
 </div>
     
   
+    
+      
+
+
+
+<div class="list__item">
+  <article class="archive__item" itemscope itemtype="http://schema.org/CreativeWork">
+    
+    <h2 class="archive__item-title" itemprop="headline">
+      
+        <a href="/docs/code-guidelines/" rel="permalink">Coding Guidelines
+</a>
+      
+    </h2>
+    
+    <p class="archive__item-excerpt" itemprop="description">Apache RocketMQ Coding
Guidelines
+</p>
+  </article>
+</div>
+    
+  
 
   
     

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/content/docs/cli-admin-tool/index.html
----------------------------------------------------------------------
diff --git a/content/docs/cli-admin-tool/index.html b/content/docs/cli-admin-tool/index.html
index 60099da..d366531 100644
--- a/content/docs/cli-admin-tool/index.html
+++ b/content/docs/cli-admin-tool/index.html
@@ -57,7 +57,7 @@
 
 
   <meta property="og:type" content="article">
-  <meta property="article:published_time" content="2016-12-27T12:03:29+08:00">
+  <meta property="article:published_time" content="2016-12-29T11:23:18+08:00">
 
 
 
@@ -227,6 +227,14 @@
             
             
 
+            <li><a href="/docs/code-guidelines/" class="">Code Guidelines</a></li>
+          
+            
+            
+
+            
+            
+
             <li><a href="/docs/pull-request/" class="">Best Practice in PR</a></li>
           
         </ul>
@@ -355,7 +363,7 @@
   <article class="page" itemscope itemtype="http://schema.org/CreativeWork">
     <meta itemprop="headline" content="CLI Admin Tool">
     <meta itemprop="description" content="RocketMQ provides a CLI admin tool belt to query,
manage and diagnose various issues.">
-    <meta itemprop="datePublished" content="December 27, 2016">
+    <meta itemprop="datePublished" content="December 29, 2016">
     <meta itemprop="dateModified" content="December 17, 2016">
 
     <div class="page__inner-wrap">

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/content/docs/cluster-deployment/index.html
----------------------------------------------------------------------
diff --git a/content/docs/cluster-deployment/index.html b/content/docs/cluster-deployment/index.html
index 4077530..559cdbc 100644
--- a/content/docs/cluster-deployment/index.html
+++ b/content/docs/cluster-deployment/index.html
@@ -57,7 +57,7 @@
 
 
   <meta property="og:type" content="article">
-  <meta property="article:published_time" content="2016-12-27T12:03:29+08:00">
+  <meta property="article:published_time" content="2016-12-29T11:23:18+08:00">
 
 
 
@@ -227,6 +227,14 @@
             
             
 
+            <li><a href="/docs/code-guidelines/" class="">Code Guidelines</a></li>
+          
+            
+            
+
+            
+            
+
             <li><a href="/docs/pull-request/" class="">Best Practice in PR</a></li>
           
         </ul>
@@ -355,7 +363,7 @@
   <article class="page" itemscope itemtype="http://schema.org/CreativeWork">
     <meta itemprop="headline" content="Cluster Configuration and Deployment">
     <meta itemprop="description" content="Prerequisite">
-    <meta itemprop="datePublished" content="December 27, 2016">
+    <meta itemprop="datePublished" content="December 29, 2016">
     <meta itemprop="dateModified" content="December 17, 2016">
 
     <div class="page__inner-wrap">

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/content/docs/code-guidelines/index.html
----------------------------------------------------------------------
diff --git a/content/docs/code-guidelines/index.html b/content/docs/code-guidelines/index.html
new file mode 100644
index 0000000..1ef032e
--- /dev/null
+++ b/content/docs/code-guidelines/index.html
@@ -0,0 +1,534 @@
+<!doctype html>
+<html lang="en" class="no-js">
+  <head>
+    <meta charset="utf-8">
+
+<!-- begin SEO -->
+
+
+
+
+
+
+
+
+
+<title>Coding Guidelines - Apache RocketMQ</title>
+
+
+
+
+<meta name="description" content="Apache RocketMQ Coding Guidelines">
+
+
+
+
+<meta property="og:locale" content="en">
+<meta property="og:site_name" content="Apache RocketMQ">
+<meta property="og:title" content="Coding Guidelines">
+
+
+
+
+  <meta property="og:description" content="Apache RocketMQ Coding Guidelines">
+
+
+
+  <meta name="twitter:site" content="@ApacheRocketMQ">
+  <meta name="twitter:title" content="Coding Guidelines">
+  <meta name="twitter:description" content="Apache RocketMQ Coding Guidelines">
+  <meta name="twitter:url" content="">
+
+  
+    <meta name="twitter:card" content="summary">
+    
+  
+
+  
+
+
+
+  
+
+  
+
+
+
+
+
+  <meta property="og:type" content="article">
+  <meta property="article:published_time" content="2016-12-29T11:23:18+08:00">
+
+
+
+
+
+
+
+
+  <script type="application/ld+json">
+    {
+      "@context" : "http://schema.org",
+      "@type" : "Person",
+      "name" : "Apache RocketMQ",
+      "url" : null,
+      "sameAs" : null
+    }
+  </script>
+
+
+
+
+
+
+<!-- end SEO -->
+
+
+<link href="/feed.xml" type="application/atom+xml" rel="alternate" title="Apache RocketMQ
Feed">
+
+<!-- http://t.co/dKP3o1e -->
+<meta name="HandheldFriendly" content="True">
+<meta name="MobileOptimized" content="320">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+<script>
+  document.documentElement.className = document.documentElement.className.replace(/\bno-js\b/g,
'') + ' js ';
+</script>
+
+<!-- For all browsers -->
+<link rel="stylesheet" href="/assets/css/main.css">
+
+<meta http-equiv="cleartype" content="on">
+    <!-- start custom head snippets -->
+
+<!-- insert favicons. use http://realfavicongenerator.net/ -->
+
+<!-- end custom head snippets -->
+  </head>
+
+  <body class="layout--single">
+
+    <!--[if lt IE 9]>
+<div class="notice--danger align-center" style="margin: 0;">You are using an <strong>outdated</strong>
browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> to
improve your experience.</div>
+<![endif]-->
+    <div class="masthead">
+  <div class="masthead__inner-wrap">
+    <div class="masthead__menu">
+      <nav id="site-nav" class="greedy-nav">
+        <button><div class="navicon"></div></button>
+        <ul class="visible-links">
+          <li class="masthead__menu-item masthead__menu-item--lg"><a href="/">Apache
RocketMQ</a></li>
+          
+            
+            <li class="masthead__menu-item"><a href="/docs/quick-start/">Documentation</a></li>
+          
+            
+            <li class="masthead__menu-item"><a href="/year-archive/">Blog</a></li>
+          
+            
+            <li class="masthead__menu-item"><a href="/community/">Community</a></li>
+          
+            
+            <li class="masthead__menu-item"><a href="/about/">About</a></li>
+          
+        </ul>
+        <ul class="hidden-links hidden"></ul>
+      </nav>
+    </div>
+  </div>
+</div>
+
+    
+
+
+
+<div id="main" role="main">
+  
+  <div class="sidebar sticky">
+  
+  
+    
+      
+      
+      
+    
+    
+      
+
+<nav class="nav__list">
+  
+  <input id="ac-toc" name="accordion-toc" type="checkbox" />
+  <label for="ac-toc">Toggle Menu</label>
+  <ul class="nav__items">
+    
+      <li>
+        
+          <span class="nav__sub-title">User Guide</span>
+        
+
+        
+        <ul>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/quick-start/" class="">Quick Start</a></li>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/motivation/" class="">Motivation</a></li>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/core-concept/" class="">Core Concept</a></li>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/cli-admin-tool/" class="">CLI Admin Tool</a></li>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/cluster-deployment/" class="">Cluster Configuration
& Deployment</a></li>
+          
+        </ul>
+        
+      </li>
+    
+      <li>
+        
+          <span class="nav__sub-title">Contributor Guide</span>
+        
+
+        
+        <ul>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/code-guidelines/" class="active">Code Guidelines</a></li>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/pull-request/" class="">Best Practice in PR</a></li>
+          
+        </ul>
+        
+      </li>
+    
+      <li>
+        
+          <span class="nav__sub-title">Developer Guide</span>
+        
+
+        
+        <ul>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/motivation/" class="">Architecture & Design</a></li>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/motivation/" class="">Communication Protocol</a></li>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/core-concept/" class="">Persistence</a></li>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/cli-admin-tool/" class="">Replication</a></li>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/cluster-deployment/" class="">Service Discovery
& Load Balance</a></li>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/cluster-deployment/" class="">Message Filter</a></li>
+          
+        </ul>
+        
+      </li>
+    
+      <li>
+        
+          <span class="nav__sub-title">Best Practice</span>
+        
+
+        
+        <ul>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/motivation/" class="">Broker</a></li>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/motivation/" class="">Producer</a></li>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/core-concept/" class="">Consumer</a></li>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/cli-admin-tool/" class="">Virtualization</a></li>
+          
+            
+            
+
+            
+            
+
+            <li><a href="/docs/cluster-deployment/" class="">Frequently Asked
Questions</a></li>
+          
+        </ul>
+        
+      </li>
+    
+  </ul>
+</nav>
+    
+  
+  </div>
+
+
+  <article class="page" itemscope itemtype="http://schema.org/CreativeWork">
+    <meta itemprop="headline" content="Coding Guidelines">
+    <meta itemprop="description" content="Apache RocketMQ Coding Guidelines">
+    <meta itemprop="datePublished" content="December 29, 2016">
+    <meta itemprop="dateModified" content="December 30, 2016">
+
+    <div class="page__inner-wrap">
+      
+        <header>
+          <h1 class="page__title" itemprop="headline">Coding Guidelines
+</h1>
+          
+        </header>
+      
+
+      <section class="page__content" itemprop="text">
+        <aside class="sidebar__right">
+<nav class="toc">
+    <header><h4 class="nav__title"><i class="fa fa-file-text"></i>
On This Page</h4></header>
+<ul class="toc__menu" id="markdown-toc">
+  <li><a href="#introduction" id="markdown-toc-introduction">Introduction</a></li>
+  <li><a href="#code-template-for-idea" id="markdown-toc-code-template-for-idea">Code
template for idea</a>    <ul>
+      <li><a href="#import-code-style" id="markdown-toc-import-code-style">Import
code style</a></li>
+      <li><a href="#import-copyright" id="markdown-toc-import-copyright">Import
copyright</a>        <ul>
+          <li><a href="#1-import-from-directory-style---copyright---apachexml" id="markdown-toc-1-import-from-directory-style---copyright---apachexml">1.
Import from directory style -&gt; copyright -&gt; Apache.xml</a></li>
+          <li><a href="#2-choose-apache-copyright" id="markdown-toc-2-choose-apache-copyright">2.
Choose Apache copyright</a></li>
+        </ul>
+      </li>
+      <li><a href="#remove-author-javadoc-tag" id="markdown-toc-remove-author-javadoc-tag">Remove
author javadoc tag</a></li>
+    </ul>
+  </li>
+</ul>
+
+  </nav>
+</aside>
+
+<h1 id="introduction">Introduction</h1>
+<p>This document describes formatting rules and guidelines for software source code.
Note that this document does not cover best programming practices or techniques. It is solely
concentrating on source code formatting and conventions.</p>
+
+<p>Studies have shown that 80% of development time spent on software maintenance which
involves software source code understanding, refactoring and support. Established and enforced
code formatting rules and guidelines improve source code readability, promote team code ownership,
allow engineers understand new code more quickly and thorough as well as simplify maintenance.</p>
+
+<h1 id="code-template-for-idea">Code template for idea</h1>
+<h2 id="import-code-style">Import code style</h2>
+<p><img src="/assets/images/code_guidelines/codestyle.png" alt="codestyle" /></p>
+
+<h2 id="import-copyright">Import copyright</h2>
+<h3 id="1-import-from-directory-style---copyright---apachexml">1. Import from directory
style -&gt; copyright -&gt; Apache.xml</h3>
+<p><img src="/assets/images/code_guidelines/copyright.png" alt="copyright" /></p>
+<h3 id="2-choose-apache-copyright">2. Choose Apache copyright</h3>
+<p><img src="/assets/images/code_guidelines/copyright-choose.png" alt="copyright-choose"
/></p>
+
+<h2 id="remove-author-javadoc-tag">Remove author javadoc tag</h2>
+<p><img src="/assets/images/code_guidelines/author-tag.png" alt="author-javadoc-tag"
/></p>
+
+
+        
+      </section>
+
+      <footer class="page__meta">
+        
+        
+
+
+        
+          <p class="page__date"><strong><i class="fa fa-fw fa-calendar" aria-hidden="true"></i>
Updated:</strong> <time datetime="2016-12-30">December 30, 2016</time></p>
+        
+      </footer>
+
+      <section class="page__share">
+  
+    <h4 class="page__share-title">Share on</h4>
+  
+
+  <a href="https://twitter.com/intent/tweet?via=ApacheRocketMQ&text=Coding Guidelines
/docs/code-guidelines/" class="btn btn--twitter" title="Share on Twitter"><i class="fa
fa-fw fa-twitter" aria-hidden="true"></i><span> Twitter</span></a>
+
+  <a href="https://www.facebook.com/sharer/sharer.php?u=/docs/code-guidelines/" class="btn
btn--facebook" title="Share on Facebook"><i class="fa fa-fw fa-facebook" aria-hidden="true"></i><span>
Facebook</span></a>
+
+  <a href="https://plus.google.com/share?url=/docs/code-guidelines/" class="btn btn--google-plus"
title="Share on Google Plus"><i class="fa fa-fw fa-google-plus" aria-hidden="true"></i><span>
Google+</span></a>
+
+  <a href="https://www.linkedin.com/shareArticle?mini=true&url=/docs/code-guidelines/"
class="btn btn--linkedin" title="Share on LinkedIn"><i class="fa fa-fw fa-linkedin"
aria-hidden="true"></i><span> LinkedIn</span></a>
+</section>
+
+
+      
+  <nav class="pagination">
+    
+      <a href="/docs/pull-request/" class="pagination--pager" title="Best Practice in
Pull Request
+">Previous</a>
+    
+    
+      <a href="#" class="pagination--pager disabled">Next</a>
+    
+  </nav>
+
+    </div>
+
+    
+      <div class="page__comments">
+  
+  
+    <h4 class="page__comments-title">Leave a Comment</h4>
+    <section id="disqus_thread"></section>
+  
+</div>
+    
+  </article>
+
+  
+  
+</div>
+
+    <div class="page__footer">
+      <footer>
+        <!-- start custom footer snippets -->
+
+<!-- end custom footer snippets -->
+        <div class="page__footer-follow">
+  <ul class="social-icons">
+    
+      <li><strong>Follow:</strong></li>
+    
+    
+      <li><a href="https://twitter.com/ApacheRocketMQ"><i class="fa fa-fw
fa-twitter-square" aria-hidden="true"></i> Twitter</a></li>
+    
+    
+    
+      <li><a href="http://github.com/apache/incubator-rocketmq"><i class="fa
fa-fw fa-github" aria-hidden="true"></i> GitHub</a></li>
+    
+    
+    <li><a href="/feed.xml"><i class="fa fa-fw fa-rss-square" aria-hidden="true"></i>
Feed</a></li>
+  </ul>
+</div>
+
+<div class="page__footer-copyright">Copyright &copy; 2016 <a href="http://www.apache.org/">The
Apache Software Foundation</a>. All Rights Reserved.</div>
+      </footer>
+    </div>
+
+    <script src="/assets/js/main.min.js"></script>
+
+
+
+
+
+  
+  <script type="text/javascript">
+  	/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
+  	var disqus_shortname = 'rocketmq';
+
+  	/* * * DON'T EDIT BELOW THIS LINE * * */
+  	(function() {
+  		var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async =
true;
+  		dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
+  		(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+  	})();
+
+  	/* * * DON'T EDIT BELOW THIS LINE * * */
+  	(function () {
+  		var s = document.createElement('script'); s.async = true;
+  		s.type = 'text/javascript';
+  		s.src = '//' + disqus_shortname + '.disqus.com/count.js';
+  		(document.getElementsByTagName('HEAD')[0] || document.getElementsByTagName('BODY')[0]).appendChild(s);
+  	}());
+  </script>
+  <noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments
powered by Disqus.</a></noscript>
+
+
+
+
+
+
+  </body>
+</html>

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/content/docs/core-concept/index.html
----------------------------------------------------------------------
diff --git a/content/docs/core-concept/index.html b/content/docs/core-concept/index.html
index 38f224f..3c65c6e 100644
--- a/content/docs/core-concept/index.html
+++ b/content/docs/core-concept/index.html
@@ -57,7 +57,7 @@
 
 
   <meta property="og:type" content="article">
-  <meta property="article:published_time" content="2016-12-27T12:03:29+08:00">
+  <meta property="article:published_time" content="2016-12-29T11:23:18+08:00">
 
 
 
@@ -227,6 +227,14 @@
             
             
 
+            <li><a href="/docs/code-guidelines/" class="">Code Guidelines</a></li>
+          
+            
+            
+
+            
+            
+
             <li><a href="/docs/pull-request/" class="">Best Practice in PR</a></li>
           
         </ul>
@@ -355,7 +363,7 @@
   <article class="page" itemscope itemtype="http://schema.org/CreativeWork">
     <meta itemprop="headline" content="Core Concept">
     <meta itemprop="description" content="">
-    <meta itemprop="datePublished" content="December 27, 2016">
+    <meta itemprop="datePublished" content="December 29, 2016">
     <meta itemprop="dateModified" content="December 17, 2016">
 
     <div class="page__inner-wrap">

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/content/docs/motivation/index.html
----------------------------------------------------------------------
diff --git a/content/docs/motivation/index.html b/content/docs/motivation/index.html
index 2034f43..6641517 100644
--- a/content/docs/motivation/index.html
+++ b/content/docs/motivation/index.html
@@ -57,7 +57,7 @@
 
 
   <meta property="og:type" content="article">
-  <meta property="article:published_time" content="2016-12-27T12:03:29+08:00">
+  <meta property="article:published_time" content="2016-12-29T11:23:18+08:00">
 
 
 
@@ -227,6 +227,14 @@
             
             
 
+            <li><a href="/docs/code-guidelines/" class="">Code Guidelines</a></li>
+          
+            
+            
+
+            
+            
+
             <li><a href="/docs/pull-request/" class="">Best Practice in PR</a></li>
           
         </ul>
@@ -355,7 +363,7 @@
   <article class="page" itemscope itemtype="http://schema.org/CreativeWork">
     <meta itemprop="headline" content="Motivation">
     <meta itemprop="description" content="In the early stages, we constructed our distributed
messaging middleware on the basis of ActiveMQ 5.x(less than 5.3). Our international business
uses it for async communication, search, social network activity stream, data pipeline, even
in our trade order process. As our trade business throughput rises more and more inconceivably,
pressure originating from our messaging cluster also become more and more obvious.">
-    <meta itemprop="datePublished" content="December 27, 2016">
+    <meta itemprop="datePublished" content="December 29, 2016">
     <meta itemprop="dateModified" content="December 17, 2016">
 
     <div class="page__inner-wrap">

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/content/docs/pull-request/index.html
----------------------------------------------------------------------
diff --git a/content/docs/pull-request/index.html b/content/docs/pull-request/index.html
index 669f674..30dbfa5 100644
--- a/content/docs/pull-request/index.html
+++ b/content/docs/pull-request/index.html
@@ -57,7 +57,7 @@
 
 
   <meta property="og:type" content="article">
-  <meta property="article:published_time" content="2016-12-27T12:03:29+08:00">
+  <meta property="article:published_time" content="2016-12-29T11:23:18+08:00">
 
 
 
@@ -227,6 +227,14 @@
             
             
 
+            <li><a href="/docs/code-guidelines/" class="">Code Guidelines</a></li>
+          
+            
+            
+
+            
+            
+
             <li><a href="/docs/pull-request/" class="active">Best Practice in
PR</a></li>
           
         </ul>
@@ -355,7 +363,7 @@
   <article class="page" itemscope itemtype="http://schema.org/CreativeWork">
     <meta itemprop="headline" content="Best Practice in Pull Request">
     <meta itemprop="description" content="There are several ways to setup Git for committers
and contributors. Contributors can safely setup Git any way they choose but committers should
take extra care since they can push new commits to the master at Apache and various policies
there make backing out mistakes problematic. Therefore all but very small changes should go
through a PR, even for committers. To keep the commit history clean take note of the use of
–squash below when merging into apache/master.">
-    <meta itemprop="datePublished" content="December 27, 2016">
+    <meta itemprop="datePublished" content="December 29, 2016">
     <meta itemprop="dateModified" content="December 25, 2016">
 
     <div class="page__inner-wrap">
@@ -374,7 +382,7 @@
 <nav class="toc">
     <header><h4 class="nav__title"><i class="fa fa-file-text"></i>
On This Page</h4></header>
 <ul class="toc__menu" id="markdown-toc">
-  <li><a href="#git-setup-for-committers" id="markdown-toc-git-setup-for-committers">Git
setup for Committers</a></li>
+  <li><a href="#git-setup-for-contributors" id="markdown-toc-git-setup-for-contributors">Git
setup for Contributors</a></li>
   <li><a href="#do-some-work-on-the-branch" id="markdown-toc-do-some-work-on-the-branch">Do
some work on the branch</a></li>
   <li><a href="#how-to-create-a-pr-committers" id="markdown-toc-how-to-create-a-pr-committers">How
to create a PR (committers)</a></li>
   <li><a href="#how-to-create-a-pr-contributors" id="markdown-toc-how-to-create-a-pr-contributors">How
to create a PR (contributors)</a></li>
@@ -390,7 +398,7 @@
   </nav>
 </aside>
 
-<h1 id="git-setup-for-committers">Git setup for Committers</h1>
+<h1 id="git-setup-for-contributors">Git setup for Contributors</h1>
 <p>This describes setup for one local repo and two remotes. It allows you to push the
code on your machine to either your Github repo or to git-wip-us.apache.org. You will want
to fork github’s apache/incubator-rocketmq to your own account on github, this will enable
Pull Requests of your own. Cloning this fork locally will set up “origin” to point to
your remote fork on github as the default remote. So if you perform “git push origin master”
it will go to github.</p>
 
 <p>To attach to the apache git repo do the following:</p>
@@ -456,11 +464,11 @@ Merging pull requests are equivalent to a “pull” of a contributor’s
branch
 
 <div class="highlighter-rouge"><pre class="highlight"><code>git checkout
master      # switch to local master branch
 git pull apache master   # fast-forward to current remote HEAD
-git pull --squash https://github.com/cuser/incubator-rocketmq.git cbranch  # merge to master
+git pull --squash https://github.com/cuser/incubator-rocketmq.git ROCKETMQ-xxxx  # merge
to master
 </code></pre>
 </div>
 
-<p>–squash ensures all PR history is squashed into single commit, and allows committer
to use his/her own message. Read git help for merge or pull for more information about –squash
option. In this example we assume that the contributor’s Github handle is “cuser” and
the PR branch name is “cbranch”. Next, resolve conflicts, if any, or ask a contributor
to rebase on top of master, if PR went out of sync.</p>
+<p>–squash ensures all PR history is squashed into single commit, and allows committer
to use his/her own message. Read git help for merge or pull for more information about –squash
option. In this example we assume that the contributor’s Github handle is “cuser” and
the PR branch name is “ROCKETMQ-xxxx”. Next, resolve conflicts, if any, or ask a contributor
to rebase on top of master, if PR went out of sync.</p>
 
 <p>If you are ready to merge your own (committer’s) PR you probably only need to
merge (not pull), since you have a local copy that you’ve been working on. This is the branch
that you used to create the PR.</p>
 
@@ -557,7 +565,8 @@ In this case all subsequent comments will automatically be copied to jira
withou
 ">Previous</a>
     
     
-      <a href="#" class="pagination--pager disabled">Next</a>
+      <a href="/docs/code-guidelines/" class="pagination--pager" title="Coding Guidelines
+">Next</a>
     
   </nav>
 

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/content/docs/quick-start/index.html
----------------------------------------------------------------------
diff --git a/content/docs/quick-start/index.html b/content/docs/quick-start/index.html
index ff49715..e6fc288 100644
--- a/content/docs/quick-start/index.html
+++ b/content/docs/quick-start/index.html
@@ -57,7 +57,7 @@
 
 
   <meta property="og:type" content="article">
-  <meta property="article:published_time" content="2016-12-27T12:03:29+08:00">
+  <meta property="article:published_time" content="2016-12-29T11:23:18+08:00">
 
 
 
@@ -227,6 +227,14 @@
             
             
 
+            <li><a href="/docs/code-guidelines/" class="">Code Guidelines</a></li>
+          
+            
+            
+
+            
+            
+
             <li><a href="/docs/pull-request/" class="">Best Practice in PR</a></li>
           
         </ul>
@@ -355,7 +363,7 @@
   <article class="page" itemscope itemtype="http://schema.org/CreativeWork">
     <meta itemprop="headline" content="Quick Start">
     <meta itemprop="description" content="How to quickly install and setup Apache RocketMQ.">
-    <meta itemprop="datePublished" content="December 27, 2016">
+    <meta itemprop="datePublished" content="December 29, 2016">
     <meta itemprop="dateModified" content="December 17, 2016">
 
     <div class="page__inner-wrap">

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/content/feed.xml
----------------------------------------------------------------------
diff --git a/content/feed.xml b/content/feed.xml
index 0821bcd..94a4e42 100644
--- a/content/feed.xml
+++ b/content/feed.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?><?xml-stylesheet type="text/xml" href="/feed.xslt.xml"?><feed
xmlns="http://www.w3.org/2005/Atom"><generator uri="http://jekyllrb.com" version="3.3.1">Jekyll</generator><link
href="/feed.xml" rel="self" type="application/atom+xml" /><link href="/" rel="alternate"
type="text/html" /><updated>2016-12-27T12:03:29+08:00</updated><id>//</id><title
type="html">Apache RocketMQ</title><subtitle>The homepage of RocketMQ.</subtitle><author><name>{&quot;name&quot;=&gt;nil,
&quot;avatar&quot;=&gt;&quot;/assets/images/rmq-logo.png&quot;, &quot;bio&quot;=&gt;&quot;A
fast, low latency, reliable, scalable, distributed MOM.&quot;, &quot;location&quot;=&gt;&quot;Hangzhou,
China&quot;, &quot;email&quot;=&gt;&quot;dev@rocketmq.incubator.apache.org&quot;,
&quot;uri&quot;=&gt;&quot;http://incubator.staging.apache.org/projects/rocketmq.html&quot;,
&quot;bitbucket&quot;=&gt;nil, &quot;codepen&quot;=&gt;nil, &quot;dribbble&quot;=&gt;nil,
&quot;flickr&quot;=&gt;nil, &quo
 t;facebook&quot;=&gt;nil, &quot;foursquare&quot;=&gt;nil, &quot;github&quot;=&gt;&quot;apache/incubator-rocketmq&quot;,
&quot;google_plus&quot;=&gt;nil, &quot;keybase&quot;=&gt;nil, &quot;instagram&quot;=&gt;nil,
&quot;lastfm&quot;=&gt;nil, &quot;linkedin&quot;=&gt;nil, &quot;pinterest&quot;=&gt;nil,
&quot;soundcloud&quot;=&gt;nil, &quot;stackoverflow&quot;=&gt;&quot;http://stackoverflow.com/questions/tagged/rocketmq&quot;,
&quot;steam&quot;=&gt;nil, &quot;tumblr&quot;=&gt;nil, &quot;twitter&quot;=&gt;&quot;ApacheRocketMQ&quot;,
&quot;vine&quot;=&gt;nil, &quot;weibo&quot;=&gt;nil, &quot;xing&quot;=&gt;nil,
&quot;youtube&quot;=&gt;nil, &quot;quora&quot;=&gt;&quot;topic/RocketMQ&quot;}</name><email>dev@rocketmq.incubator.apache.org</email><uri>http://incubator.staging.apache.org/projects/rocketmq.html</uri></author><entry><title
type="html">Mastering Component Compatible Dependency</title><link href="/maven/mastering-component-compatible-dependency/"
rel="alternate" type="text/html" t
 itle="Mastering Component Compatible Dependency" /><published>2016-12-23T00:00:00+08:00</published><updated>2016-12-23T00:00:00+08:00</updated><id>/maven/mastering-component-compatible-dependency</id><content
type="html" xml:base="/maven/mastering-component-compatible-dependency/">&lt;p&gt;This
article mainly includes three parts.at first,I will introduce compatibility principle(more
details see &lt;a href=&quot;http://blog.csdn.net/fengjia10/article/details/7799227&quot;&gt;here&lt;/a&gt;)
briefly.followed by a detailed elaborating about Java component compatible dependency,including
the interface-oriented programming,single component signature protection,single component
compatibility protection and multi-component compatibility compile time checking.Finally is
the review and prospect,especially about &lt;strong&gt;Dependency Mediator&lt;/strong&gt;
project.&lt;/p&gt;
+<?xml version="1.0" encoding="utf-8"?><?xml-stylesheet type="text/xml" href="/feed.xslt.xml"?><feed
xmlns="http://www.w3.org/2005/Atom"><generator uri="http://jekyllrb.com" version="3.3.1">Jekyll</generator><link
href="/feed.xml" rel="self" type="application/atom+xml" /><link href="/" rel="alternate"
type="text/html" /><updated>2016-12-29T11:23:18+08:00</updated><id>//</id><title
type="html">Apache RocketMQ</title><subtitle>The homepage of RocketMQ.</subtitle><author><name>{&quot;name&quot;=&gt;nil,
&quot;avatar&quot;=&gt;&quot;/assets/images/rmq-logo.png&quot;, &quot;bio&quot;=&gt;&quot;A
fast, low latency, reliable, scalable, distributed MOM.&quot;, &quot;location&quot;=&gt;&quot;Hangzhou,
China&quot;, &quot;email&quot;=&gt;&quot;dev@rocketmq.incubator.apache.org&quot;,
&quot;uri&quot;=&gt;&quot;http://incubator.staging.apache.org/projects/rocketmq.html&quot;,
&quot;bitbucket&quot;=&gt;nil, &quot;codepen&quot;=&gt;nil, &quot;dribbble&quot;=&gt;nil,
&quot;flickr&quot;=&gt;nil, &quo
 t;facebook&quot;=&gt;nil, &quot;foursquare&quot;=&gt;nil, &quot;github&quot;=&gt;&quot;apache/incubator-rocketmq&quot;,
&quot;google_plus&quot;=&gt;nil, &quot;keybase&quot;=&gt;nil, &quot;instagram&quot;=&gt;nil,
&quot;lastfm&quot;=&gt;nil, &quot;linkedin&quot;=&gt;nil, &quot;pinterest&quot;=&gt;nil,
&quot;soundcloud&quot;=&gt;nil, &quot;stackoverflow&quot;=&gt;&quot;http://stackoverflow.com/questions/tagged/rocketmq&quot;,
&quot;steam&quot;=&gt;nil, &quot;tumblr&quot;=&gt;nil, &quot;twitter&quot;=&gt;&quot;ApacheRocketMQ&quot;,
&quot;vine&quot;=&gt;nil, &quot;weibo&quot;=&gt;nil, &quot;xing&quot;=&gt;nil,
&quot;youtube&quot;=&gt;nil, &quot;quora&quot;=&gt;&quot;topic/RocketMQ&quot;}</name><email>dev@rocketmq.incubator.apache.org</email><uri>http://incubator.staging.apache.org/projects/rocketmq.html</uri></author><entry><title
type="html">Mastering Component Compatible Dependency</title><link href="/maven/mastering-component-compatible-dependency/"
rel="alternate" type="text/html" t
 itle="Mastering Component Compatible Dependency" /><published>2016-12-23T00:00:00+08:00</published><updated>2016-12-23T00:00:00+08:00</updated><id>/maven/mastering-component-compatible-dependency</id><content
type="html" xml:base="/maven/mastering-component-compatible-dependency/">&lt;p&gt;This
article mainly includes three parts.at first,I will introduce compatibility principle(more
details see &lt;a href=&quot;http://blog.csdn.net/fengjia10/article/details/7799227&quot;&gt;here&lt;/a&gt;)
briefly.followed by a detailed elaborating about Java component compatible dependency,including
the interface-oriented programming,single component signature protection,single component
compatibility protection and multi-component compatibility compile time checking.Finally is
the review and prospect,especially about &lt;strong&gt;Dependency Mediator&lt;/strong&gt;
project.&lt;/p&gt;
 
 &lt;aside class=&quot;sidebar__right&quot;&gt;
 &lt;nav class=&quot;toc&quot;&gt;

http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/3cf041e2/content/sitemap.xml
----------------------------------------------------------------------
diff --git a/content/sitemap.xml b/content/sitemap.xml
index 0fdaf8d..0c31eec 100644
--- a/content/sitemap.xml
+++ b/content/sitemap.xml
@@ -27,6 +27,9 @@
 <loc>/docs/pull-request/</loc>
 </url>
 <url>
+<loc>/docs/code-guidelines/</loc>
+</url>
+<url>
 <loc>/about/</loc>
 </url>
 <url>
@@ -68,4 +71,7 @@
 <url>
 <loc>/docs/pull-request/</loc>
 </url>
+<url>
+<loc>/docs/code-guidelines/</loc>
+</url>
 </urlset>


Mime
View raw message