This is an automated email from the ASF dual-hosted git repository. wangxin pushed a commit to branch asf-site in repository https://gitbox.apache.org/repos/asf/incubator-dubbo-website.git
The following commit(s) were added to refs/heads/asf-site by this push: new 7d07e49 补充 code style ci 的注意事项 (#205) 7d07e49 is described below commit 7d07e492bcabd9f7dbbe8047e07ad1ac2c0e816f Author: xujingfeng <250577...@qq.com> AuthorDate: Mon Dec 17 22:32:57 2018 +0800 补充 code style ci 的注意事项 (#205) * 增加code style的注意事项 --- docs/en-us/developers/guide_dev.md | 12 +++++++++++- docs/zh-cn/developers/guide_dev.md | 12 ++++++++++++ img/manage_profiles.png | Bin 0 -> 430 bytes 3 files changed, 23 insertions(+), 1 deletion(-) diff --git a/docs/en-us/developers/guide_dev.md b/docs/en-us/developers/guide_dev.md index 7063606..e01d324 100644 --- a/docs/en-us/developers/guide_dev.md +++ b/docs/en-us/developers/guide_dev.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](/img/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/docs/zh-cn/developers/guide_dev.md b/docs/zh-cn/developers/guide_dev.md index b976be4..a2ab61e 100644 --- a/docs/zh-cn/developers/guide_dev.md +++ b/docs/zh-cn/developers/guide_dev.md @@ -68,3 +68,15 @@ git push origin your_awesome_patch 我们提供了IntelliJ idea的模版文件[dubbo_codestyle_for_idea.xml](https://github.com/apache/incubator-dubbo/tree/master/codestyle/dubbo_codestyle_for_idea.xml),您可以将它导入到IDE。 如果使用Eclipse,可以通过参考该文件手动配置。 + +**注意事项** + +使用 dubbo_codestyle_for_idea.xml 为你的 IDEA 设置代码格式是贡献代码前至关重要的一个步骤,否则你将会无法通过 Travis CI 的代码风格校验,下面几个步骤给你演示了如何配置代码格式: + +1. 进入菜单页 `Editor > Code Style` +2. 在 Code Style 页面的 scheme 菜单中点击 ![manage profiles](/img/manage_profiles.png) 选项 +在下拉列表中选择 `Import Scheme`, 接着选择 `IntelliJ IDEA code style XML` 导入 xml 文件 +3. 输入你的格式名称,方便在不同工程之间进行识别,最后别忘了 ⏎ 来保存更改. + +设置完成后,IDEA 会帮助你自动 reformat 代码 + diff --git a/img/manage_profiles.png b/img/manage_profiles.png new file mode 100644 index 0000000..1664d67 Binary files /dev/null and b/img/manage_profiles.png differ