Version: 3.0.5

CONTRIBUTING

我们非常欢迎社区的开发者向 Taro 做出贡献。在提交贡献之前,请花一些时间阅读以下内容,保证贡献是符合规范并且能帮助到社区。

Taro 组成

NPM 包描述
@tarojs/taroTaro 运行时框架
@tarojs/taro-h5Taro H5 运行时框架
@tarojs/taro-rnTaro React Native 运行时框架
@tarojs/taro-weappTaro 微信小程序运行时框架
@tarojs/taro-swanTaro 百度智能小程序运行时框架
@tarojs/taro-ttTaro 字节跳动小程序运行时框架
@tarojs/taro-alipayTaro 支付宝小程序运行时框架
@tarojs/taro-qqTaro QQ 小程序运行时框架
@tarojs/taro-quickappTaro 快应用 运行时框架
@tarojs/reduxTaro 小程序 Redux 支持
@tarojs/redux-h5Taro H5 Redux 支持
@tarojs/redux-rnTaro React Native Redux 支持
@tarojs/mobx-commonTaro MobX 公共模块
@tarojs/mobxTaro 小程序 MobX 支持
@tarojs/mobx-h5Taro H5 MobX 支持
@tarojs/mobx-rnTaro React Native MobX 支持
@tarojs/routerTaro H5 路由
@tarojs/async-await支持使用 async/await 语法
@tarojs/cliTaro 开发工具
@tarojs/transformer-wxTaro 小程序转换器
@tarojs/taroizeTaro 小程序编译器
@tarojs/taro-rn-runnerTaro React Native 打包编译工具
@tarojs/webpack-runnerTaro H5 端 Webpack 打包编译工具
@tarojs/componentsTaro 标准组件库,H5 版
@tarojs/components-rnTaro 标准组件库,React Native 版
@tarojs/components-qaTaro 标准组件库,快应用 版
@tarojs/plugin-babelTaro Babel 编译插件
@tarojs/plugin-sassTaro Sass 编译插件
@tarojs/plugin-lessTaro Less 编译插件
@tarojs/plugin-stylusTaro Stylus 编译插件
@tarojs/plugin-cssoTaro CSS 压缩插件
@tarojs/plugin-uglifyjsTaro JS 压缩插件
eslint-config-taroTaro ESLint 规则
eslint-plugin-taroTaro ESLint 插件

Issue 报告指南

如果提交的是 Bug 报告,请务必遵守 Bug report 模板。

如果提交的是功能需求,请在 issue 的标题的起始处增加 [Feature request] 字符。

开发配置

你需要保证你的 Node.js 版本大于 8,把仓库 Clone 到本地。运行以下命令:

$ npm install # or yarn
$ npm run bootstrap
$ npm run build

提交 commit

整个 Taro 仓库遵从 Angular Style Commit Message Conventions,在输入 commit message 的时候请务必遵从此规范。

代码风格

  • JavaScript:JavaScript 风格遵从 JavaScript Standard Style
  • TypeScript:TypeScript 风格也是 JavaScript Standard Style 的变种,详情请看相关包目录下的 tslint.jsontsconfig.json
  • 样式:遵循相关包目录下的 .stylelintrc 风格。

Pull Request 指南

  1. 务必保证 npm run build 能够编译成功;
  2. 务必保证提交到代码遵循相关包中的 .eslintrc, .tslintrc, .stylelintrc 所规定的规范;
  3. 当相关包的 package.json 含有 npm test 命令时,必须保证所有测试用例都需要通过;
  4. 当相关包有测试用例时,请给你提交的代码也添加相应的测试用例;
  5. 提交代码 commit 时,commit 信息需要遵循 Angular Style Commit Message Conventions
  6. 如果提交到代码非常多或功能复杂,可以把 PR 分成几个 commit 一起提交。我们在合并时会会根据情况 squash。

Credits

感谢以下所有给 Taro 贡献过代码的开发者: