免費(fèi)AI編程助手
Taro 貢獻(xiàn)指南
2021-09-23 21:17 更新
我們非常歡迎社區(qū)的開發(fā)者向 Taro 做出貢獻(xiàn)。在提交貢獻(xiàn)之前，請花一些時(shí)間閱讀以下內(nèi)容，保證貢獻(xiàn)是符合規(guī)范并且能幫助到社區(qū)。
Taro 組成
| NPM 包 | 描述 |
|---|---|
| ?@tarojs/taro? | Taro 運(yùn)行時(shí)框架 |
| @tarojs/taro-h5 | Taro H5 運(yùn)行時(shí)框架 |
| @tarojs/taro-rn | Taro React Native 運(yùn)行時(shí)框架 |
| @tarojs/taro-weapp | Taro 微信小程序運(yùn)行時(shí)框架 |
| @tarojs/taro-swan | Taro 百度智能小程序運(yùn)行時(shí)框架 |
| @tarojs/taro-tt | Taro 字節(jié)跳動(dòng)小程序運(yùn)行時(shí)框架 |
| @tarojs/taro-alipay | Taro 支付寶小程序運(yùn)行時(shí)框架 |
| @tarojs/taro-qq | Taro QQ 小程序運(yùn)行時(shí)框架 |
| @tarojs/taro-quickapp | Taro 快應(yīng)用 運(yùn)行時(shí)框架 |
| @tarojs/redux | Taro 小程序 Redux 支持 |
| @tarojs/redux-h5 | Taro H5 Redux 支持 |
| @tarojs/redux-rn | Taro React Native Redux 支持 |
| @tarojs/mobx-common | Taro MobX 公共模塊 |
| @tarojs/mobx | Taro 小程序 MobX 支持 |
| @tarojs/mobx-h5 | Taro H5 MobX 支持 |
| @tarojs/mobx-rn | Taro React Native MobX 支持 |
| @tarojs/router | Taro H5 路由 |
| @tarojs/async-await | 支持使用 async/await 語法 |
| @tarojs/cli | Taro 開發(fā)工具 |
| @tarojs/transformer-wx | Taro 小程序轉(zhuǎn)換器 |
| @tarojs/taroize | Taro 小程序編譯器 |
| @tarojs/taro-rn-runner | Taro React Native 打包編譯工具 |
| @tarojs/webpack-runner | Taro H5 端 Webpack 打包編譯工具 |
| @tarojs/components | Taro 標(biāo)準(zhǔn)組件庫，H5 版 |
| @tarojs/components-rn | Taro 標(biāo)準(zhǔn)組件庫，React Native 版 |
| @tarojs/components-qa | Taro 標(biāo)準(zhǔn)組件庫，快應(yīng)用 版 |
| @tarojs/plugin-babel | Taro Babel 編譯插件 |
| @tarojs/plugin-sass | Taro Sass 編譯插件 |
| @tarojs/plugin-less | Taro Less 編譯插件 |
| @tarojs/plugin-stylus | Taro Stylus 編譯插件 |
| @tarojs/plugin-csso | Taro CSS 壓縮插件 |
| @tarojs/plugin-uglifyjs | Taro JS 壓縮插件 |
| eslint-config-taro | Taro ESLint 規(guī)則 |
| eslint-plugin-taro | Taro ESLint 插件 |
Issue 報(bào)告指南
如果提交的是 Bug 報(bào)告，請務(wù)必遵守 Bug report 模板。
如果提交的是功能需求，請?jiān)?issue 的標(biāo)題的起始處增加 [Feature request] 字符。
開發(fā)配置
你需要保證你的 Node.js 版本大于 8，把倉庫 Clone 到本地。運(yùn)行以下命令：
$ npm install # or yarn$ npm run bootstrap
提交 commit
整個(gè) Taro 倉庫遵從 Angular Style Commit Message Conventions，在輸入 commit message 的時(shí)候請務(wù)必遵從此規(guī)范。
代碼風(fēng)格
JavaScript：JavaScript 風(fēng)格遵從 JavaScript Standard Style。TypeScript：TypeScript 風(fēng)格也是 JavaScript Standard Style 的變種，詳情請看相關(guān)包目錄下的tslint.json和tsconfig.json。- 樣式：遵循相關(guān)包目錄下的
.stylelintrc風(fēng)格。
Pull Request 指南
- 務(wù)必保證
npm run build能夠編譯成功； - 務(wù)必保證提交到代碼遵循相關(guān)包中的
.eslintrc,.tslintrc,.stylelintrc所規(guī)定的規(guī)范； - 當(dāng)相關(guān)包的
package.json含有npm test命令時(shí)，必須保證所有測試用例都需要通過； - 當(dāng)相關(guān)包有測試用例時(shí)，請給你提交的代碼也添加相應(yīng)的測試用例；
- 提交代碼 commit 時(shí)，commit 信息需要遵循 Angular Style Commit Message Conventions。
- 如果提交到代碼非常多或功能復(fù)雜，可以把 PR 分成幾個(gè) commit 一起提交。我們在合并時(shí)會(huì)會(huì)根據(jù)情況 squash。
Credits
感謝以下所有給 Taro 貢獻(xiàn)過代碼的開發(fā)者：
以上內(nèi)容是否對您有幫助：
更多建議：