code review by hf: do add web group file
Showing
1 changed file
with
42 additions
and
25 deletions
@@ -2,46 +2,63 @@ | @@ -2,46 +2,63 @@ | ||
2 | 2 | ||
3 | ## 亲们,请统一编程风格! (PHP) | 3 | ## 亲们,请统一编程风格! (PHP) |
4 | ======================= | 4 | ======================= |
5 | -> class Yoho | ||
6 | -> { | ||
7 | -> public static function callApi($param) | ||
8 | -> { | ||
9 | -> if (true) { | ||
10 | -> // comment | ||
11 | -> echo 'Tab is space 4'; | ||
12 | -> } | ||
13 | -> } | ||
14 | -> } | ||
15 | - | ||
16 | -* 推荐在编辑器中针对项目设置好 * | ||
17 | -* 注意花括号的位置 * | ||
18 | -* 注意TAB键缩进设置为4个空格 * | ||
19 | -* 注意类、方法、变量的命名,请使用驼峰式 如“YohoBuy”* | ||
20 | -* 请仔细阅读PHP高效编码技巧 * | 5 | +> <?php |
6 | + | ||
7 | +> class Yoho | ||
8 | + | ||
9 | +> { | ||
10 | + | ||
11 | +> public static function callApi($param) | ||
12 | + | ||
13 | +> { | ||
14 | + | ||
15 | +> if (true) { | ||
16 | + | ||
17 | +> // comment | ||
18 | + | ||
19 | +> echo 'Tab is space 4'; | ||
20 | + | ||
21 | +> } | ||
22 | + | ||
23 | +> } | ||
24 | + | ||
25 | +> } | ||
26 | + | ||
27 | + | ||
28 | +* 推荐在编辑器中针对项目设置好 | ||
29 | +* 注意花括号的位置 | ||
30 | +* 注意TAB键缩进设置为4个空格 | ||
31 | +* 注意类、方法、变量的命名,请使用驼峰式 如“YohoBuy” | ||
32 | +* 请仔细阅读<http://git.dev.yoho.cn/web/yohobuy/blob/develop/docs/PHP%E9%AB%98%E6%95%88%E7%BC%96%E7%A0%81%E6%8A%80%E5%B7%A7.doc> | ||
21 | 33 | ||
22 | ## 亲们,请写代码注释! | 34 | ## 亲们,请写代码注释! |
23 | ========================= | 35 | ========================= |
24 | 36 | ||
25 | -* 重要或复杂的业务逻辑代码中必须附有注释描述说明 * | 37 | +* 重要或复杂的业务逻辑代码中必须附有注释描述说明 |
26 | 38 | ||
27 | ## 亲们,请做代码评审! | 39 | ## 亲们,请做代码评审! |
28 | ========================= | 40 | ========================= |
29 | 41 | ||
30 | -* 代码推送到远程主干之前,必须经过其他同事帮你审查! 只有审查通过后才允许推送到远程. * | 42 | +* 代码推送到远程主干之前,必须经过其他同事帮你审查! 只有审查通过后才允许推送到远程. |
31 | 43 | ||
32 | -** 场景1: 小A 完成一个功能, 需要合并到远程主干,找小B 帮他审查代码,小B发现 小A 代码里有好多缺陷, | ||
33 | -需要提出来,让小A修改. (小A不修改,不允许帮他合并到主干) ** | 44 | +场景1: 小A 完成一个功能, 需要合并到远程主干,找小B 帮他审查代码,小B发现 小A 代码里有好多缺陷, |
45 | +需要提出来,让小A修改. (小A不修改,不允许帮他合并到主干) | ||
34 | 46 | ||
35 | -** 场景2: 小C 完成一个功能, 需要合并到远程主干,找小D 帮他审查代码,小D 发现 小C 代码写得很不错,都懂了, | ||
36 | -这时小D 可以把代码合并到主干,小D 需要 写上code review by 小D: 代码相关的描述内容 (合并到远程之后,小C 和 小D 需要对这个功能负责! ) ** | 47 | +场景2: 小C 完成一个功能, 需要合并到远程主干,找小D 帮他审查代码,小D 发现 小C 代码写得很不错,都懂了, |
48 | +这时小D 可以把代码合并到主干,小D 需要 写上code review by 小D: 代码相关的描述内容 (合并到远程之后,小C 和 小D 需要对这个功能负责! ) | ||
37 | 49 | ||
38 | -** 场景3: 小C 代码已合并到主干,突然间发现还有一个需要改进的地方需要调整,则检出主干代码, 再修改, | ||
39 | -修改好之后请找同事帮助审查! 不要直接推远程,只有审查通过才可以推送到主干! ** | 50 | +场景3: 小C 代码已合并到主干,突然间发现还有一个需要改进的地方需要调整,则检出主干代码, 再修改, |
51 | +修改好之后请找同事帮助审查! 不要直接推远程,只有审查通过才可以推送到主干! | ||
40 | 52 | ||
41 | ## 重要特点 | 53 | ## 重要特点 |
42 | -* 该文件 自 2016年1月1日起,WEB组 开始实施!* | 54 | +* 该文件 自 2016年1月1日起,WEB组 开始实施! |
55 | + | ||
43 | 1. PHP代码不按 统一的编程风格 编写的,发现后 请主动向组长 王欢宝 塞 5个1元硬币, 作为 WEB组 日常经费 | 56 | 1. PHP代码不按 统一的编程风格 编写的,发现后 请主动向组长 王欢宝 塞 5个1元硬币, 作为 WEB组 日常经费 |
57 | + | ||
44 | 2. JS代码有验证不通过代码推到远程主干的,发现后 请主动向组长 徐祁 塞 5个1元硬币, 作为 WEB组 日常经费 | 58 | 2. JS代码有验证不通过代码推到远程主干的,发现后 请主动向组长 徐祁 塞 5个1元硬币, 作为 WEB组 日常经费 |
59 | + | ||
45 | 3. 王欢宝 和 徐祁 代码有不符合规范的,请主动向架构师 梁志锋 塞 10个1元硬币, 作为 WEB组 日常经费 | 60 | 3. 王欢宝 和 徐祁 代码有不符合规范的,请主动向架构师 梁志锋 塞 10个1元硬币, 作为 WEB组 日常经费 |
61 | + | ||
46 | 4. 架构师 梁志锋 不定期对大家代码审查,发现没有注明审查者的,推送在远程的代码作者,需要向 梁志锋 塞 10个1元硬币, 作为 WEB组 日常经费 | 62 | 4. 架构师 梁志锋 不定期对大家代码审查,发现没有注明审查者的,推送在远程的代码作者,需要向 梁志锋 塞 10个1元硬币, 作为 WEB组 日常经费 |
63 | + | ||
47 | 5. 主干分支上 一个功能中出现3个及以上严重致命问题的,一经发现,代码作者及审查者 请主动向 梁志锋、王欢宝、徐祁 各塞 10个1元硬币, 作为 WEB组 日常经费 | 64 | 5. 主干分支上 一个功能中出现3个及以上严重致命问题的,一经发现,代码作者及审查者 请主动向 梁志锋、王欢宝、徐祁 各塞 10个1元硬币, 作为 WEB组 日常经费 |
-
Please register or login to post a comment