Appearance
规范
为了回避不必要的错误、命名纠结以及方便团队协作,请团队成员遵守以下规范。
项目命名规范
- 在 sale_go group 新建测试项目,项目命名规范为 日期+项目名称,如
20210601_project
;
文件命名规范
- 命名只包含 字母、数字和下划线;
- 禁止使用减号(
-
)。
图片命名规范
- 命名只包含 字母、数字和下划线;
图片保存规范
- 保存图片要【存储为web所用格式】;
- 保存图片优先保存为
jpg
格式,如果图片有透明的部分,保存为png
格式。
图片大小规范
- 在开发阶段,图片资源建议单张图片小于
1M
,避免出现大的背景图; - 在生产阶段,建议图片资源小于
1M
; - 如需减少图片大小,可以通过修改图片宽度,或者将图片切成多份;
- 特殊情况,如
flash
导出的雪碧图过大,可以跳过该规范。
编码规范
- 注意代码换行缩进,保持可读性;
CSS
的class
命名应使用小写,单词之间使用-
进行分割,如app-content
;js
变量命名应使用驼峰命名法,如pageIndex
;Vue
组件名应该始终是多个单词的,这样做可以避免跟 HTML 元素相冲突;Vue
单文件组件的文件名尽量是单词大写开头,如AppComponent.vue
;Vue
语法应遵循 Vue.js 风格指南。
Git 规范
- 版本管理:完成某一功能、某一模块、或者新增代码量较多时,请及时
push
; - 版本提交说明: 在
commit
添加详细修改内容,不要只使用update
、修改
、以及与本次修改无关的描述,请参考 阮一峰《Commit message 编写指南》 填写 git 日志; - 团队合作
merge
: 和其他成员共同开始同一项目时,在push
命令前,记得使用pull
命令解决冲突。
设计规范
- 创意部设计规范 包括了移动端设计规范、PC端设计规范、视频尺寸规范、视频剪辑规范。
PM 对接清单
- 创意部项目对接清单 包含了 PM 需要提供给前端的素材以及注意事项,可以将该清单发给 PM 节省对接时间。