You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dubbo.apache.org by hu...@apache.org on 2018/07/12 08:59:13 UTC

[incubator-dubbo] 01/03: Polish CONTRIBUTING.

This is an automated email from the ASF dual-hosted git repository.

huxing pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-dubbo.git

commit f7ea7e7096f174cba6b081d41361e816698d042c
Author: Huxing Zhang <hu...@gmail.com>
AuthorDate: Thu Jul 12 16:16:07 2018 +0800

    Polish CONTRIBUTING.
---
 CONTRIBUTING.md | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d6434f9..ad77d31 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,14 +1,13 @@
 
 ## Contributing to dubbo
 Dubbo is released under the non-restrictive Apache 2.0 license, and follows a very standard Github development process, using Github tracker for issues and merging pull requests into master. If you want to contribute even something trivial please do not hesitate, but follow the guidelines below.
+
 ### Sign the Contributor License Agreement
 Before we accept a non-trivial patch or pull request we will need you to sign the Contributor License Agreement. Signing the contributor’s agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.
-### Code Conventions
-Our code style is almost in line with the standard java conventions(Popular IDE's default setting satisfy this), only changed the following two restricts:  
-1. Classes under 'org.apache.dubbo.*' and 'com.taobao.*' package are grouped separately, and put on top of all other 'imports'.  
-2. If there are more than 120 characters in current line, start a new line.
 
-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. If you use Eclipse you can config manually by referencing the same file.  
+### 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:  
+* If there are more than 120 characters in current line, start a new line.
 
 * Make sure all new .java files to have a simple Javadoc class comment with at least a @date tag identifying birth, and preferably at least a paragraph on what the class is for.
 
@@ -23,3 +22,8 @@ We provide a template file [dubbo_codestyle_for_idea.xml](https://github.com/apa
 * If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).
 
 * When writing a commit message please follow these conventions, if you are fixing an existing issue please add Fixes #XXX at the end of the commit message (where XXX is the issue number).
+
+### 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. 
+If you use Eclipse you can config manually by referencing the same file.
\ No newline at end of file