Skip to content

Latest commit

 

History

History
116 lines (86 loc) · 5.9 KB

FRONTEND.md

File metadata and controls

116 lines (86 loc) · 5.9 KB

云运动前端规范

(1).前端资源加载的规范

    1.js,css分别放在各自的文件夹内,相同的js,css文件放在公共的前端资源进行加载。

(2).类名命名规范

    1.类名应有描述性,杜绝一切拼音、或拼音英文混杂的命名方式
    2.如果类名包括多个单词,应使用驼峰式命名方式,每个单词的第一个字母必须大写, 不允许连续大写
    3.命名规则有三部分组成:模块+位置+小功能点
    例如:左边侧栏的卡种管理
    class = 'menuLeftCard';
    例如:右边卡种管理头部搜索css类
    class = 'cardHeaderChoice'
    例如:卡种管理中间列表样式
    class = 'cardBodyTableList'
    例如:卡种列表分页样式
    class = 'cardListPage'

(3).页面要求

    1.不要出现js代码,有js代码块分别要独立成js文件利用前端资源进行加载

(4).代码提交规范

1.新建工作流(代码必须在工作流上面修改)

2.提交时 先提交代码,在切换到dev , 拉取dev 然后进入工作流合并到工作流

3.进入dev,将工作流合并到dev

4.推送到测试环境

5.代码提交格式

   【自己的现在的职务】系统功能 - 大功能 - 详细功能

   例如 : [开发]云系统 - 前台首页 - 编辑轮播图

详细步骤 1. 打开自己sourceTree,在dev拉取最新代码

     2. 点击顶部菜单 “Git工作流”->创建新功能->创建到以自己姓名名称命名的文件夹内便于区分,功能名称是自己做的功能的名称

     3.创建完成,比如是feature/lihuien/首页轮播图管理

     4.代码完成后,首先点击顶部菜单 “提交”->然后切换分支到dev->dev拉取最新代码->在切换到工作流

     5.单击dev,然后右键,会出现“合并dev至当前分支”->点击

     6.然后切换到dev->单击工作流右键 ->出现“合并工作流feature/lihuien/首页轮播图管理代码至当前分支”,点击确定

     7.最后点击顶部菜单“推送”->选择dev->确定->切换到自己工作流或者在创建新的工作流进行下一个功能开发

    提示:如果提交出现冲突,请找冲突文件中相应的开发一起及时解决,不得擅自解决,以防会往代码库传入垃圾代码或者破坏队友的功能完整性

6.Teambition任务卡片规范

1.自己每天的任务,如果完成就及时点掉

2.如果任务延期   标清延期原因

3.如果需要别人合作 就添加任务关联

4.自己每天上班必须填写自己任务卡片

5.如果任务需要挂起 写清楚挂起原因

6.写清楚备注,填写子任务,如果有需要就添加图片描述


任务具体格式:

【自己的现在的职务】系统功能 - 大功能 - 详细功能

[前端]云系统 - 后台 - 员工列表

备注:1.会员页面的加载
      2.团课页面的加载...

子任务1 【前端】会员页面 - 头部页面 - 搜索框
等
###  7.功能代码的提交规范
1.没有完成的功能不能提交dev上,要保证dev上的页面是正常的。
2.每完成一个小功能点提交到自己的分支远程,避免污染dev代码。

8.添加注释

1.控制器方法,视图js文件需要添加注释

9.js文件的命名规则

 1.使用驼峰命名法
 2.自己写的js文件命名规范,不是angularJs文件的,用当前页面控制器名称命名,是angularJs的文件用控制器名称+Ctrl.js命名规范

10.页面要求

1.加载前端资源的时候,不要随便放位置,use的放在一起
2.注释掉的代码记得删掉,不要在代码块显示

11.前端资源的加载

1.一个页面引用的第三方插件独立成一个单独的Asset资源,自己写的css和js文件在独立成一个单独的Asset资源,并且自己建的前端资源要依赖于引用的插件
2.引用外部的插件名为:插件名+Asset,自定义资源命名为:页面+Ctrl+Asset

12.前后端开发流程

1.原型定稿,需要前端人员熟悉原型需求,经过讨论后决定原型是否开发,不得私自拿到原型进行开发
2.前端人员需要更改的模块如果后台开发进行中,需要及时和后台人员进行沟通,避免出现冲突的问题

13.工作工具流程

1.第一件事每天9:30之前把当天任务列到teambition上,子任务标明时间
2.第二件事在sourceTree上拉取最新代码进行开发。
3.在当天任务中,如果按时完成子任务记得点掉,如有延期请标明备注。如有不遵守行为规范者,记录一次。
4.每天工作中记得beartychat和teambition时刻在线,并时刻关注前端组信息,如有通知消息本人不知,后果自负

14.angularJs的书写规范

1.注意大小写,使用驼峰命名法
2.每个方法之前都要有注释写上:作者,时间,模块,作用
例如: /**
        * @return string
        * @auther:XXX
        * create 2017-3-30
        * 交互 - 登录 - 手机号判断
        */
3.注释格式有:<!---->

15.接口规范

    1.统一用json格式与数据对接

16.任务卡片命名规则

   1.如果页面是纯排版,就标明[排版]业务后台+模块+功能
   2.后台没有提供数据,自定义数组的,卡片就写上[渲染]业务后台+模块+功能
   3.后台提供数据,任务卡片就写上[交互]业务卡片+模块+功能
   4.如果是手机端,任务卡片就写上[排版]或者[渲染]或者[交互]手机端+模块+功能