From 06488870268ef17e47992082254cb7f026b12291 Mon Sep 17 00:00:00 2001 From: xujingfeng <250577914@qq.com> Date: Mon, 17 Dec 2018 15:56:06 +0800 Subject: [PATCH] add the notice of checkstyle (#2983) * add the notice of code style * modify the pic * del teh faq.md, move to dubbo-website --- CONTRIBUTING.md | 12 +++++++++++- FAQ.md | 25 ------------------------- codestyle/manage_profiles.png | Bin 0 -> 430 bytes 3 files changed, 11 insertions(+), 26 deletions(-) delete mode 100644 FAQ.md create mode 100644 codestyle/manage_profiles.png diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bd7dc2022c..b987b16e65 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -63,4 +63,14 @@ Thanks for contributing! ### 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 +If you use Eclipse you can config manually by referencing the same file. + +**NOTICE** + +It is very important to set the dubbo_codestyle_for_idea.xml, otherwise you will fail to pass the Travis CI. Steps to set the code style are as below: + +1. Enter `Editor > Code Style` +2. To manage a code style scheme, in the Code Style page, select the desired scheme from the drop-down list, and click ![manage profiles](codestyle/manage_profiles.png). +From the drop-down list, select `Import Scheme`, then select this option `IntelliJ IDEA code style XML` to import scheme +3. In the Scheme field, type the name of the new scheme and press ⏎ to save the changes. + diff --git a/FAQ.md b/FAQ.md deleted file mode 100644 index 28e2f0cc56..0000000000 --- a/FAQ.md +++ /dev/null @@ -1,25 +0,0 @@ -### Where is dubbo-admin? - -dubbo-admin has been moved from core repository to https://github.com/apache/incubator-dubbo-ops since 2.6.1 - -### Which version should I choose? - -Currently, dubbo keeps 3 versions evolve in parallel: - -* 2.7.x (master): requires Java 1.8, major feature branch. - -* 2.6.x: requires Java 1.6, minor feature & bugfix branch, GA, production ready. - -* 2.5.x: requires Java 1.6, maintenance branch, only accept security vulnerability and critical bugfix, expected to be EOL soon. - -check [this](https://github.com/apache/incubator-dubbo/issues/1208) for detailed version management plan. - -For contributors, please make sure all changes on the right branch, that is, most of the pull request should go to 2.7.x, and be backported to 2.6.x and 2.5.x if necessary. If the fix is specific to a branch, please make sure your pull request goes to the right branch. - -For committers, make sure select the right label and target branch for every PR, and don't forget to back port the fix to lower version is necessary. - -#### How to register ip correctly in docker? - -[Example question](https://github.com/alibaba/dubbo/issues/742) - -Dubbo supports specifying ip/port via system environment variables, examples can be found [here](https://github.com/dubbo/dubbo-samples/tree/master/dubbo-samples-docker). diff --git a/codestyle/manage_profiles.png b/codestyle/manage_profiles.png new file mode 100644 index 0000000000000000000000000000000000000000..1664d67ea43d2e2b5f38f5dc2e08ae91b195cd3a GIT binary patch literal 430 zcmeAS@N?(olHy`uVBq!ia0vp^(m*W90VEinmUA@$Db50q$YKTtz9S&aI8~buq=LP~ z)7O>#A+rd-puic`HP^sGt`Q}Ur6n2pMGPy~o$&w)@st3CTvCgZi!uvJGV}8oggF(J zf#O^sap(Mk%A(Blj1q=5{Aa9yqI_V{qSQo?QiYPt+*AhB@BExV8BUN)aDG}zd16s2 zLu|o+kaBLY;hDwBIf+1}MGV^yZ0QFIbAW`y6N~aP^U@g(NIz=_im^lVmlh?bGJO5t z{2HdrIX^cyHLrx>+nH(mfnsbRWg(d*IjIaQ-d$1$id1^KIEHAPzk1P-uf>4JC9v-g zqo(Xb4uy$kA~M~F91lo