2
2
3
3
我们非常欢迎社区的开发者向 Taro 做出贡献。在提交贡献之前,请花一些时间阅读以下内容,保证贡献是符合规范并且能帮助到社区。
4
4
5
- ## 一、Issue 报告指南
6
-
7
- 请遵循 [ ` Taro Issue Template ` ] ( https://taro-issue-pro.pf.jd.com/ ) 的指引创建 Bug Report 或 Feature Request 类 Issues。
8
-
9
- ## 二、Pull Request 贡献指南
5
+ ## Pull Request 贡献指南
10
6
11
7
### 1. 环境准备
12
8
13
- > 需要安装 [ Node.js 16 ] ( https://nodejs.org/en/ ) (建议安装 ` 16. 20.0 ` 及以上版本)及 [ pnpm 7 ] ( https://pnpm.io/zh/installation )
9
+ > 需要安装 [ Node.js 20 ] ( https://nodejs.org/en/ ) (建议安装 ` 20.19.2 ` 及以上版本)及 [ pnpm 10 ] ( https://pnpm.io/zh/installation )
14
10
15
11
首先把 Taro 仓库 fork 一份到自己的 Github,然后从个人仓库把项目 clone 到本地,项目默认是 ` main ` 分支。
16
12
@@ -36,7 +32,7 @@ Taro 由一系列子 npm 包组成,整体项目组织基于 **pnpm workspace**
36
32
$ pnpm --filter [package-name] run dev
37
33
```
38
34
39
- 开发过程中,一般会使用 ** link** 的方式把需要调试的包软链到一个测试项目中,然后便可进行断点调试。开发者可以根据测试项目的包管理器以及自己的喜好选择使用 [ npm link] ( https://docs.npmjs.com/cli/v7 /commands/npm-link ) 或 [ yarn link] ( https://yarnpkg.com/cli/link ) (推荐)或 [ pnpm link] ( https://pnpm.io/zh/cli/link ) 。
35
+ 开发过程中,一般会使用 ** link** 的方式把需要调试的包软链到一个测试项目中,然后便可进行断点调试。开发者可以根据测试项目的包管理器以及自己的喜好选择使用 [ npm link] ( https://docs.npmjs.com/cli/v11 /commands/npm-link ) 或 [ yarn link] ( https://yarnpkg.com/cli/link ) (推荐)或 [ pnpm link] ( https://pnpm.io/zh/cli/link ) 。
40
36
41
37
** 使用 ` yarn link ` 的具体示例如下:**
42
38
@@ -114,7 +110,7 @@ $ npm run clear-all
114
110
115
111
** 注意:**
116
112
117
- ` @tarojs/webpack5-runner ` 使用了 ` snapshot ` (测试结果快照)。在修改这两个包或其它一些包时,有可能导致这些快照失效,从而通过不了测试。当你修改了这两个包、或 Github CI 提示这些包的测试用例出错时,请运行 ` pnpm --filter [package-name] runupdateSnapshot ` 更新 snapshot 后重新提交。
113
+ ` @tarojs/webpack5-runner ` 使用了 ` snapshot ` (测试结果快照)。在修改这两个包或其它一些包时,有可能导致这些快照失效,从而通过不了测试。当你修改了这两个包、或 Github CI 提示这些包的测试用例出错时,请运行 ` pnpm --filter [package-name] run updateSnapshot ` 更新 snapshot 后重新提交。
118
114
119
115
### 5. 代码风格
120
116
@@ -128,7 +124,7 @@ $ npm run clear-all
128
124
129
125
### 7. 提交 Pull Request
130
126
131
- > 如果对 PR(Pull Request)不了解,请阅读 [ 《About Pull Requests 》] ( https://docs.github.com/en/github /collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests )
127
+ > 如果对 PR(Pull Request)不了解,请阅读 [ 《关于拉取请求 》] ( https://docs.github.com/zh/pull-requests /collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests )
132
128
133
129
完成开发后,推送到自己的 Taro 仓库,就可以准备提交 Pull Request 了。
134
130
@@ -209,12 +205,10 @@ Cargo workspace 会把编译产物输出到根目录的 `target` 文件夹中。
209
205
210
206
如对 ` @taorjs/helper ` 进行集成测试时,会把 ` target/wasm32-wasip1/release/swc_plugin_xxx.wasm ` 文件的软链到 ` packages/taro-helper/swc/swc_plugin_xxx.wasm ` 。
211
207
212
- ####
213
-
214
208
## Credits
215
209
216
210
感谢以下所有给 Taro 贡献过代码的开发者:
217
211
218
212
[ ![ contributors] ( https://opencollective.com/taro/contributors.svg?width=890&button=false )] ( https://github.com/NervJS/taro/graphs/contributors )
219
213
220
- 同时欢迎各位贡献者加入 [ Taro 开发者社区] ( http://storage.jd.com/taro-jd-com/static/contact_taro_devlop_qr.png )
214
+ 同时欢迎各位贡献者加入 [ Taro 开发者社区] ( http://storage.jd.com/taro-jd-com/static/contact_taro_devlop_qr.png )
0 commit comments