Skip to content

Commit a9dcfc1

Browse files
ianzoneyoyo837
andauthored
docs: issue template update [no ci] (#17753)
* docs: issue template update [no ci] * Update CONTRIBUTING.md Co-authored-by: Amumu <[email protected]> --------- Co-authored-by: Amumu <[email protected]>
1 parent 5d19bfa commit a9dcfc1

File tree

5 files changed

+24
-29
lines changed

5 files changed

+24
-29
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: 错误报告 🐞
1+
name: 🐞 错误报告 Bug Report
22
description: 报告新 Bug。一般性问题请在 GitHub Discussion 中发布。
33
title: "[Bug]: "
44
labels:
@@ -8,11 +8,10 @@ body:
88
- type: checkboxes
99
id: duplication
1010
attributes:
11-
label: 请先搜索是否存在类似提交
11+
label: 请先确认
1212
options:
13-
- label: 我确定这个提交不是重复的
14-
validations:
15-
required: true
13+
- label: 我已搜索并确定这个提交不是重复的
14+
required: true
1615
- type: checkboxes
1716
id: platform
1817
attributes:
@@ -71,6 +70,8 @@ body:
7170
2. Click on '....'
7271
7372
3. ...
73+
validations:
74+
required: true
7475
- type: textarea
7576
id: system
7677
attributes:

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: 📖文档问题 Docs issue
3+
- name: 📖 文档问题 Docs Issue
44
url: https://github.com/NervJS/taro-docs/issues
55
about: 文档相关问题请在这里提交
6-
- name: 📑创建提案 Proposal
6+
- name: 📑 创建提案 Proposal
77
url: https://github.com/NervJS/taro/discussions/categories/rfc
88
about: 制定 Taro 下一步的更新计划
9-
- name: 🙋🏻‍♂️发起投票 Vote
9+
- name: 🙋🏻‍♂️ 发起投票 Vote
1010
url: https://github.com/NervJS/taro/discussions/categories/polls
1111
about: 投票决定 Taro 的未来
12-
- name: 🙌🏼社区支持 General Question
12+
- name: 🙌🏼 社区支持 General Question
1313
url: https://github.com/NervJS/taro/discussions/categories/q-a
1414
about: 发布一般性问题
15-
- name: 🏗生态建设 Ecosystem
15+
- name: 🏗 生态建设 Ecosystem
1616
url: https://github.com/NervJS/taro/discussions/categories/%E7%94%9F%E6%80%81
17-
about: 工具库?组件库?快来丰富 Taro 生态
17+
about: 工具库?组件库?快来丰富 Taro 生态

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
name: 功能请求 🚀
2-
description: 提出新特性
1+
name: 🚀 功能请求 Feature Request
2+
description: 提出新的功能特性
33
title: "[Feat]: "
44
labels:
55
- triage
@@ -8,11 +8,10 @@ body:
88
- type: checkboxes
99
id: duplication
1010
attributes:
11-
label: 请先搜索是否存在类似提交
11+
label: 请先确认
1212
options:
13-
- label: 我确定这个提交不是重复的
14-
validations:
15-
required: true
13+
- label: 我已搜索并确定这个提交不是重复的
14+
required: true
1615
- type: textarea
1716
id: feature
1817
attributes:

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,4 @@ artifacts
8484

8585
# Node Addons
8686
*.node
87+
chrome

CONTRIBUTING.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,11 @@
22

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

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 贡献指南
106

117
### 1. 环境准备
128

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)
1410
1511
首先把 Taro 仓库 fork 一份到自己的 Github,然后从个人仓库把项目 clone 到本地,项目默认是 `main` 分支。
1612

@@ -36,7 +32,7 @@ Taro 由一系列子 npm 包组成,整体项目组织基于 **pnpm workspace**
3632
$ pnpm --filter [package-name] run dev
3733
```
3834

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)
4036

4137
**使用 `yarn link` 的具体示例如下:**
4238

@@ -114,7 +110,7 @@ $ npm run clear-all
114110

115111
**注意:**
116112

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 后重新提交。
118114

119115
### 5. 代码风格
120116

@@ -128,7 +124,7 @@ $ npm run clear-all
128124

129125
### 7. 提交 Pull Request
130126

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)
132128
133129
完成开发后,推送到自己的 Taro 仓库,就可以准备提交 Pull Request 了。
134130

@@ -209,12 +205,10 @@ Cargo workspace 会把编译产物输出到根目录的 `target` 文件夹中。
209205

210206
如对 `@taorjs/helper` 进行集成测试时,会把 `target/wasm32-wasip1/release/swc_plugin_xxx.wasm` 文件的软链到 `packages/taro-helper/swc/swc_plugin_xxx.wasm`
211207

212-
####
213-
214208
## Credits
215209

216210
感谢以下所有给 Taro 贡献过代码的开发者:
217211

218212
[![contributors](https://opencollective.com/taro/contributors.svg?width=890&button=false)](https://github.com/NervJS/taro/graphs/contributors)
219213

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

Comments
 (0)