Moye 开发规则

优质
小牛编辑
150浏览
2023-12-01

1、环境部署

下载下来后执行如下命令安装环境依赖

tnpm install

2、开发编译

所有模块源码均在src目录下

修改源码之后执行如下命令编译代码(gulpfile支持watch模式)

gulp

产出文件位于build目录下

3、注意事项

  • 严禁修改package.json中信息
  • 严禁修改gulpfile工程逻辑
  • 严禁增加publish tag
  • 语法请遵循babel
  • 使用箭头函数避免 self = this 指向
  • 使用{...{},...{}}进行对象合并
  • commit 信息要说明清楚修改类型以及修改内容(eg.<docs:增加开发规则文档>)

feat :新功能(feature)

fix :修补bug

docs :文档(documentation)

style :格式(不影响代码运行的变动)

refactor :重构(即不是新增功能,也不是修改bug的代码变动)

test :增加测试

chore :构建过程或辅助工具的变动

2、文档编写

1>moye框架API文档编写

请严格遵守 jsdoc 规范对 Api 进行标注

jsdoc 支持文档:http://www.css88.com/doc/jsdoc/index.html

2>moye框架及其使用工具文档编写

文档所在仓库:http://gitlab.alibaba-inc.com/de/alitv-open

文档所在分支:demo

不具备仓库权限的请联系@见羽

仓库拉取后先执行

npm install

文档存在于项目根目录中的Moye文件夹下,文档格式为markdown

修改完毕后执行以下命令构建为页面

npm run dev

构建完成后即可上传回demo分支

注意:tv.alibaba-inc.net上同步更新会有时间延迟,几分钟到十几分钟左右,blitz.yunos.com上的更新需要@见羽做同步