...
|
...
|
@@ -2,46 +2,63 @@ |
|
|
|
|
|
## 亲们,请统一编程风格! (PHP)
|
|
|
=======================
|
|
|
> class Yoho
|
|
|
> {
|
|
|
> public static function callApi($param)
|
|
|
> {
|
|
|
> if (true) {
|
|
|
> // comment
|
|
|
> echo 'Tab is space 4';
|
|
|
> }
|
|
|
> }
|
|
|
> }
|
|
|
|
|
|
* 推荐在编辑器中针对项目设置好 *
|
|
|
* 注意花括号的位置 *
|
|
|
* 注意TAB键缩进设置为4个空格 *
|
|
|
* 注意类、方法、变量的命名,请使用驼峰式 如“YohoBuy”*
|
|
|
* 请仔细阅读PHP高效编码技巧 *
|
|
|
> <?php
|
|
|
|
|
|
> class Yoho
|
|
|
|
|
|
> {
|
|
|
|
|
|
> public static function callApi($param)
|
|
|
|
|
|
> {
|
|
|
|
|
|
> if (true) {
|
|
|
|
|
|
> // comment
|
|
|
|
|
|
> echo 'Tab is space 4';
|
|
|
|
|
|
> }
|
|
|
|
|
|
> }
|
|
|
|
|
|
> }
|
|
|
|
|
|
|
|
|
* 推荐在编辑器中针对项目设置好
|
|
|
* 注意花括号的位置
|
|
|
* 注意TAB键缩进设置为4个空格
|
|
|
* 注意类、方法、变量的命名,请使用驼峰式 如“YohoBuy”
|
|
|
* 请仔细阅读<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>
|
|
|
|
|
|
## 亲们,请写代码注释!
|
|
|
=========================
|
|
|
|
|
|
* 重要或复杂的业务逻辑代码中必须附有注释描述说明 *
|
|
|
* 重要或复杂的业务逻辑代码中必须附有注释描述说明
|
|
|
|
|
|
## 亲们,请做代码评审!
|
|
|
=========================
|
|
|
|
|
|
* 代码推送到远程主干之前,必须经过其他同事帮你审查! 只有审查通过后才允许推送到远程. *
|
|
|
* 代码推送到远程主干之前,必须经过其他同事帮你审查! 只有审查通过后才允许推送到远程.
|
|
|
|
|
|
** 场景1: 小A 完成一个功能, 需要合并到远程主干,找小B 帮他审查代码,小B发现 小A 代码里有好多缺陷,
|
|
|
需要提出来,让小A修改. (小A不修改,不允许帮他合并到主干) **
|
|
|
场景1: 小A 完成一个功能, 需要合并到远程主干,找小B 帮他审查代码,小B发现 小A 代码里有好多缺陷,
|
|
|
需要提出来,让小A修改. (小A不修改,不允许帮他合并到主干)
|
|
|
|
|
|
** 场景2: 小C 完成一个功能, 需要合并到远程主干,找小D 帮他审查代码,小D 发现 小C 代码写得很不错,都懂了,
|
|
|
这时小D 可以把代码合并到主干,小D 需要 写上code review by 小D: 代码相关的描述内容 (合并到远程之后,小C 和 小D 需要对这个功能负责! ) **
|
|
|
场景2: 小C 完成一个功能, 需要合并到远程主干,找小D 帮他审查代码,小D 发现 小C 代码写得很不错,都懂了,
|
|
|
这时小D 可以把代码合并到主干,小D 需要 写上code review by 小D: 代码相关的描述内容 (合并到远程之后,小C 和 小D 需要对这个功能负责! )
|
|
|
|
|
|
** 场景3: 小C 代码已合并到主干,突然间发现还有一个需要改进的地方需要调整,则检出主干代码, 再修改,
|
|
|
修改好之后请找同事帮助审查! 不要直接推远程,只有审查通过才可以推送到主干! **
|
|
|
场景3: 小C 代码已合并到主干,突然间发现还有一个需要改进的地方需要调整,则检出主干代码, 再修改,
|
|
|
修改好之后请找同事帮助审查! 不要直接推远程,只有审查通过才可以推送到主干!
|
|
|
|
|
|
## 重要特点
|
|
|
* 该文件 自 2016年1月1日起,WEB组 开始实施!*
|
|
|
* 该文件 自 2016年1月1日起,WEB组 开始实施!
|
|
|
|
|
|
1. PHP代码不按 统一的编程风格 编写的,发现后 请主动向组长 王欢宝 塞 5个1元硬币, 作为 WEB组 日常经费
|
|
|
|
|
|
2. JS代码有验证不通过代码推到远程主干的,发现后 请主动向组长 徐祁 塞 5个1元硬币, 作为 WEB组 日常经费
|
|
|
|
|
|
3. 王欢宝 和 徐祁 代码有不符合规范的,请主动向架构师 梁志锋 塞 10个1元硬币, 作为 WEB组 日常经费
|
|
|
|
|
|
4. 架构师 梁志锋 不定期对大家代码审查,发现没有注明审查者的,推送在远程的代码作者,需要向 梁志锋 塞 10个1元硬币, 作为 WEB组 日常经费
|
|
|
|
|
|
5. 主干分支上 一个功能中出现3个及以上严重致命问题的,一经发现,代码作者及审查者 请主动向 梁志锋、王欢宝、徐祁 各塞 10个1元硬币, 作为 WEB组 日常经费 |
...
|
...
|
|