-
Notifications
You must be signed in to change notification settings - Fork 211
本地如何调试源码并贡献你的代码
LeonCheung edited this page Jun 25, 2019
·
2 revisions
PR流程请查看GitHub 的 Pull Request 是指什么意思?并且请严格按照以下要求进行
- 一定要先建立相关的issue讨论,有些PR是好的,但我们的应用的基础配置不一定要包含该功能!!!请先和官方人员讨论后再判断有没有提PR的必要
- 请保证你的js代码风格通过根目录的standardjs规范检测,在pre-commit之前我们会进行该项检查,如果不通过我们不允许合并
- ts相关代码同样需要通过standardjs规范检测,请你在提交前保证在该项目下的npm run lint代码风格检测通过
请保证你的代码符合以下要求
- 使用promise代替callback
- 不要出现过多的if else语句,请斟酌是否能够删除
- 尽量使用require.resolve来代替过长的path.resolve(__dirname, [path]),或者使用封装过的resoveApp方法
- 变量命名符合语义化
任何开源项目都可以使用npm link进行调试,举个例子,如果你想调试ykfe-utils源码并在项目中立即生效
$ cd packages/ykfe-utils
$ npm link
$ npm run watch // 让ykfe-utils源码的改动可以实时映射到构建后的目录而不需要每次手动执行npm run build
// 请开一个新的命令行窗口
$ cd example/ssr-with-js
$ npm link ykfe-utils
调试ykfe-utils有一个注意的点请查看#36