Skip to content

Latest commit

 

History

History
122 lines (81 loc) · 3.7 KB

CONTRIBUTING.md

File metadata and controls

122 lines (81 loc) · 3.7 KB
Raw

Taro Contributing Guide

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

Issue 报告指南

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

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

开发配置

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

安装依赖

基于 yarn workspace。

$ yarn

编译构建

# 全局编译
$ yarn build # 等价于 lerna run build

# 编译某个子包，如 `@tarojs/cli`
$ lerna run build --scope=@tarojs/cli

新增/删除依赖

可以分为三种情况：

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

1. 根目录

# 新增
$ yarn add -W -D <dependency>

# 删除
$ yarn remove -W -D <dependency>

2. 操作某个子包

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

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

# 如遇到报错 "expected workspace package to exist for"，请使用 [email protected] 再尝试。
# 相关 issues：
#   - https://github.com/yarnpkg/yarn/issues/7807
#   - https://github.com/yarnpkg/yarn/issues/7734
$ npx [email protected] workspace @tarojs/cli add <dependency>

3. 操作所有子包

# 新增
$ yarn workspaces add <dependency>

# 删除
$ yarn workspaces remove <dependency>

清理所有依赖

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

运行子包的 npm script

$ lerna run <script-name> --scope=<workspace> --stream

提交发布

$ yarn run version --lerna_version=<version>
$ git add .
$ git commit -m "chore(release): publish <version>"

提交 commit

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

代码风格

  • JavaScript：JavaScript 风格遵从 JavaScript Standard Style。
  • TypeScript：TypeScript 风格也是 JavaScript Standard Style 的变种，详情请看相关包目录下的 tslint.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 开发者社区