Skip to content

Latest commit

 

History

History
144 lines (94 loc) · 4.01 KB

CONTRIBUTING.md

File metadata and controls

144 lines (94 loc) · 4.01 KB
Raw

Taro Contributing Guide

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

Issue 报告指南

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

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

开发配置

你需要保证你的 Node.js 版本大于 12

安装依赖

基于 pnpm workspace。

$ pnpm install

编译构建

# 全局编译
$ pnpm run build # 等价于 pnpm -r --filter=./packages/* run build

# 编译某个子包，如 `@tarojs/cli`
$ pnpm --filter @tarojs/cli run dev

在其他项目中测试

先在 taro 项目目录下执行以下命令：

# 编译某个子包，如 `@tarojs/plugin-mini-ci`
$ pnpm -r --filter ./packages/taro-plugin-mini-ci build
$ pnpm link --global

然后在引用该子包的项目下执行：

yarn link @tarojs/plugin-mini-ci

接着，就可以在引用该子包的项目中从本地使用该子包了。在测试完毕后，可以执行以下命令取消链接：

yarn unlink @tarojs/plugin-mini-ci

新增/删除依赖

可以分为三种情况：

应该尽量把子包的 devDependencies 作为根目录的 devDependencies，从而安装在根目录。 如果版本遇到冲突，可以安装在子包内。

1. 根目录

# 新增
$ pnpm add -wD <dependency>

# 删除
$ pnpm remove -wD <dependency>

2. 操作某个子包

# 为某个子包（如 @tarojs/cli）新增一个依赖
$ pnpm --filter @tarojs/cli add <dependency>

# 为某个子包（如 @tarojs/cli）删除一个依赖
$ pnpm --filter @tarojs/cli remove <dependency>

3. 操作所有子包

# 新增
$ pnpm -r --filter=./packages/* add <dependency>

# 删除
$ pnpm -r --filter=./packages/* remove <dependency>

清理所有依赖

# 包括删除根目录的 node_modules 和所有 workspace 里的 node_modules
$ npm run clear-all

运行子包的 npm script

$ pnpm --filter <workspace> run <script-name>

提交发布

  • PR 发布规则

    $ pnpm version <version>

  • feat/** 分支发布规则

    $ pnpm version <version> --tag=<tag>

提交 commit

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

代码风格

  • JavaScript：JavaScript 风格遵从 JavaScript Standard Style。
  • TypeScript：TypeScript 风格也是 JavaScript Standard Style 的变种，详情请看相关包目录下的 eslint.json 和 tsconfig.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 贡献过代码的开发者：

contributors

同时欢迎各位贡献者加入 Taro 开发者社区