vipshop#2 修改链接及相关内容

1011641270 · Jun 3, 2018 · 3fd5972 · 3fd5972
1 parent 7730841
commit 3fd5972
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -32,13 +32,11 @@
 其他常用问题排查及性能调优工具: [btrace](https://github.com/btraceio/btrace)，[greys](https://github.com/oldmanpushcart/greys-anatomy)，[async-profiler](https://github.com/jvm-profiling-tools/async-profiler)
 
 
-# Support and contribute
+# How to contribute
 
 VJTools官方微信讨论群，请搜索微信号viptech128(唯技术)，添加好友后加入。
 
-所有建议与问题，请在[Issues](https://github.com/vipshop/vjtools/issues)发起。
-
-所有代码提交，请走[Pull Request](https://github.com/vipshop/vjtools/pulls)流程。
+所有报Bug、建议与咨询，请在[Issues](https://github.com/vipshop/vjtools/issues)发起；所有代码提交，请走[Pull Request](https://github.com/vipshop/vjtools/pulls)流程。
 
 对于优秀的代码提交和建议，唯品会将不吝发挥电商本色，给予vip.com 购物卡的奖励 ！！！
 

diff --git a/docs/standard/README.md b/docs/standard/README.md
@@ -31,7 +31,7 @@
 
 规则落地主要依靠代码格式化模版与[Sonar代码规则检查](https://www.sonarqube.org/)。
 
-其中Sonar规则不尽如人意的地方，我们进行了定制。相对于PMD与FindBugs，Sonar规则非常易于修改。
+其中Sonar规则不尽如人意的地方，我们进行了定制。
 
 * [Eclipse/Intellij 格式模板](https://github.com/vipshop/vjtools/tree/master/standard/formatter)
 * [Sonar 规则修改示例](https://github.com/vipshop/vjtools/tree/master/standard/sonar-vj)

diff --git a/standard/formatter/README.md b/standard/formatter/README.md
@@ -1,6 +1,6 @@
 # 公司通用代码格式化模板
 
-定制原因详见[第二章:格式规约](/standard/docs/chapter02.md)，同时参考了一些Intellij IDEA默认模板的部分设置。
+定制原因详见[唯品会Java开发手册 第二章:格式规约](https://vipshop.github.io/vjtools/#/standard/chapter02)，同时参考了一些Intellij IDEA默认模板的部分设置。
 
 将下列profile下载并导入IDE即可，导入后Profile名称为`vipshop2.0`：
 
@@ -19,13 +19,7 @@
 
 注意：Eclipse后来的build-in模板，代码行宽已经默认120。
 
-## 2. 与原Venus代码格式化模板的区别
-
-* 不格式化JavaDoc
-* 不格式化文件头注释(即License声明部分)
-* 参考Intellij IDEA默认模板的修改(见后)
-
-## 3. 与IDEA默认模板的区别
+## 2. 与IDEA默认模板的区别
 
 
 本模板参考了Intellij IDEA默认模板中如下部分： 

diff --git a/standard/sonar-vj/README.md b/standard/sonar-vj/README.md
@@ -1,7 +1,8 @@
-
 # Sonar VJ 规则
 
-因为Sonar有些规则存在误报的情况，我们在力所能及的范围内对规则的实现进行了修改以符合我们的规范。
+我们使用[Sonar代码规则检查工具](https://www.sonarqube.org/)来辅助[唯品会Java开发手册](https://vipshop.github.io/vjtools/#/standard/)的落地。选择的原因是它同时提供了服务端的公共报表，及IDE端的Sonar Lint插件，而且对比PMD与FindBugs，规则也相对容易定制。
+
+针对Sonar有些规则存在误报的情况，我们在力所能及的范围内对规则的实现进行了修改，以符合我们的规范。
 
 根据[Writing Custom Java Rules 101](https://docs.sonarqube.org/display/PLUG/Writing+Custom+Java+Rules+101)，从[Sample Project](https://github.com/SonarSource/sonar-custom-rules-examples/tree/master/java-custom-rules)复制创建，对[Sonar Java](https://github.com/SonarSource/sonar-java/tree/master/java-checks/src/main/java/org/sonar/java/checks)规则进行修改。