我们非常欢迎社区的开发者向 Taro 做出贡献。在提交贡献之前,请花一些时间阅读以下内容,保证贡献是符合规范并且能帮助到社区。
如果提交的是 Bug 报告,请务必遵守 Bug report
模板。
如果提交的是功能需求,请在 issue 的标题的起始处增加 [Feature request]
字符。
你需要保证你的 Node.js 版本大于 8,把仓库 Clone 到本地。运行以下命令:
$ npm install # or yarn
$ npm run bootstrap
整个 Taro 仓库遵从 Angular Style Commit Message Conventions,在输入 commit message 的时候请务必遵从此规范。
JavaScript
:JavaScript 风格遵从 JavaScript Standard Style。TypeScript
:TypeScript 风格也是 JavaScript Standard Style 的变种,详情请看相关包目录下的tslint.json
和tsconfig.json
。- 样式:遵循相关包目录下的
.stylelintrc
风格。
- 务必保证
npm run build
能够编译成功; - 务必保证提交到代码遵循相关包中的
.eslintrc
,.tslintrc
,.stylelintrc
所规定的规范; - 当相关包的
package.json
含有npm test
命令时,必须保证所有测试用例都需要通过; - 当相关包有测试用例时,请给你提交的代码也添加相应的测试用例;
- 提交代码 commit 时,commit 信息需要遵循 Angular Style Commit Message Conventions。
- 如果提交到代码非常多或功能复杂,可以把 PR 分成几个 commit 一起提交。我们在合并时会会根据情况 squash。
感谢以下所有给 Taro 贡献过代码的开发者: