Skip to content

Commit

Permalink
Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
dongyajie committed Nov 30, 2023
0 parents commit 3dc4fdb
Show file tree
Hide file tree
Showing 1,670 changed files with 198,567 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .browserslistrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Chrome >= 51
iOS >= 10
13 changes: 13 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# http://editorconfig.org
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false
7 changes: 7 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"root": true,
"extends": ["@vant"],
"rules": {
"prefer-object-spread": "off"
}
}
5 changes: 5 additions & 0 deletions .gitee/ISSUE_TEMPLATE.zh-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
注意:gitee 中为 vant 的镜像仓库,不进行 issue 处理。

请移步 GitHub issues 进行反馈:

https://github.com/vant-ui/vant/issues
39 changes: 39 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contributing to Vant

The following is a set of guidelines for contributing to Vant. Please spend several minutes in reading these guidelines before you create an issue or pull request.

Anyway, these are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

## Opening an Issue

If you think you have found a bug, or have a new feature idea, please start by making sure it hasn't already been reported or fixed. You can search through existing issues and PRs to see if someone has reported one similar to yours.

Next, create a new issue that briefly explains the problem, and provides a bit of background as to the circumstances that triggered it, and steps to reproduce it.

## Submitting a Pull Request

It's welcomed to pull request, And there are some tips about that:

- Before working on a large change, it is best to open an issue first to discuss it with the maintainers.

- When in doubt, keep your pull requests small. To give a PR the best chance of getting accepted, don't bundle more than one feature or bug fix per pull request. It's always best to create two smaller PRs than one big one.

- When adding new features or modifying existing, please attempt to include tests to confirm the new behavior.

- Rebase before creating a PR to keep commit history clear.

- Add some descriptions and refer relative issues for you PR.

## Getting started

You will need [Node.js >= 14](https://nodejs.org) and [pnpm](https://pnpm.io).

```bash
git clone [email protected]:vant-ui/vant.git

# Install dependencies
pnpm i

# Start development
pnpm dev
```
12 changes: 12 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# These are supported funding model platforms

github: [chenjiahan]
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/template-1-bug-report-vant.zh-CN.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: 我要反馈 Vant 的 Bug
description: 通过标准模板进行 Bug 反馈。
title: "[Bug Report] 请在此填写标题"
labels: ["bug: need confirm"]
body:
- type: markdown
attributes:
value: |
在提交 Bug 报告前,请注意:
- 确认你的问题无法通过官方文档得到解决。
- 确认你搜索过 [历史 issue](https://github.com/vant-ui/vant/issues),并且没有发现同样的问题。
- 如果不是反馈 Bug,请到 [Discussions 讨论区](https://github.com/vant-ui/vant/discussions) 发帖。
- type: input
id: reproduce
attributes:
label: 重现链接
description: 请提供一个尽可能简单的 [codesandbox](https://codesandbox.io/s/vant-3-issue-template-8fuq5o) 或 GitHub 仓库链接。不要填写无效的链接,这会导致你的 issue 被直接关闭。
validations:
required: true

- type: input
id: version
attributes:
label: Vant 版本
description: 你正在使用的 Vant 版本是多少?(请填写 node_modules/vant/package.json 里实际安装的版本)
placeholder: 比如 3.2.0
validations:
required: true

- type: textarea
id: description
attributes:
label: 描述一下你遇到的问题。
placeholder: 比如:弹窗无法展示、日历组件报错
validations:
required: true

- type: textarea
id: reproduce-steps
attributes:
label: 重现步骤
description: 请提供一个最简单的操作步骤,方便我们快速重现问题。
placeholder: |
比如:
1. 点击按钮
2. 弹窗无法展示
validations:
required: true

- type: input
id: browsers
attributes:
label: 设备/浏览器
description: 在哪些设备/浏览器上能重现这个问题?
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/template-2-bug-report-vant-cli.zh-CN.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: 我要反馈 Vant Cli 的 Bug
description: 通过标准模板进行 Bug 反馈。
title: "[Bug Report] 请在此填写标题"
labels: ["bug: need confirm", "cli"]
body:
- type: markdown
attributes:
value: |
在提交 Bug 报告前,请注意:
- 确认你的问题无法通过官方文档得到解决。
- 确认你搜索过 [历史 issue](https://github.com/vant-ui/vant/issues),并且没有发现同样的问题。
- 如果不是反馈 Bug,请到 [Discussions 讨论区](https://github.com/vant-ui/vant/discussions) 发帖。
- type: input
id: reproduce
attributes:
label: 重现链接
description: 请提供一个尽可能简单的 [codesandbox](https://codesandbox.io/s/vant-3-issue-template-8fuq5o) 或 GitHub 仓库链接。不要填写无效的链接,这会导致你的 issue 被直接关闭。
validations:
required: true

- type: input
id: version
attributes:
label: Vant Cli 版本
description: 你正在使用的 Vant Cli 版本是多少?(请填写 node_modules/@vant/cli/package.json 里实际安装的版本)
placeholder: 比如 3.2.0
validations:
required: true

- type: textarea
id: description
attributes:
label: 描述一下你遇到的问题。
placeholder: 比如:组件构建失败
validations:
required: true

- type: textarea
id: reproduce-steps
attributes:
label: 重现步骤
description: 请提供一个最简单的操作步骤,方便我们快速重现问题。
placeholder: |
比如:
1. 克隆仓库
2. 运行 yarn build
3. 组件构建失败
validations:
required: true
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/template-3-feature-request-vant.zh-CN.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: 我想要一个 Vant 的新功能
description: 通过标准模板描述一下你的功能需求。
title: "[Feature Request] 请在此填写标题"
labels: ["feature: need confirm"]
body:
- type: markdown
attributes:
value: |
在提交功能需求前,请注意:
- 确认这是一个通用功能,并且无法通过现有的 API 或 Slot 实现。
- 确认你搜索过 [历史 issue](https://github.com/vant-ui/vant/issues),并且没有发现同样的需求。
- 可以先到 [Discussions 讨论区](https://github.com/vant-ui/vant/discussions) 发帖,讨论一下需求是否合理。
- type: textarea
id: description
attributes:
label: 这个功能解决了什么问题?
description: 请尽可能详细地说明这个功能的使用场景。
validations:
required: true

- type: textarea
id: api
attributes:
label: 你期望的 API 是什么样子的?
description: 描述一下这个新功能的 API,并提供一些代码示例。
placeholder: |
```xml
<van-button some-prop="xxx" />
```
validations:
required: true
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: 我想要一个 Vant Cli 的新功能
description: 通过标准模板描述一下你的功能需求。
title: "[Feature Request] 请在此填写标题"
labels: ["feature: need confirm", "cli"]
body:
- type: markdown
attributes:
value: |
在提交功能需求前,请注意:
- 确认这是一个通用功能,并且无法通过现有的 API 实现。
- 确认你搜索过 [历史 issue](https://github.com/vant-ui/vant/issues),并且没有发现同样的需求。
- 可以先到 [Discussions 讨论区](https://github.com/vant-ui/vant/discussions) 发帖,讨论一下需求是否合理。
- type: textarea
id: description
attributes:
label: 这个功能解决了什么问题?
description: 请尽可能详细地说明这个功能的使用场景。
validations:
required: true

- type: textarea
id: api
attributes:
label: 你期望的 API 是什么样子的?
description: 描述一下这个新功能的 API,并提供一些代码示例。
validations:
required: true
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/template-5-bug-report-vant.en-US.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Bug Report
description: Use issue template to report a bug.
title: "[Bug Report] Title"
labels: ["bug: need confirm"]
body:
- type: input
id: reproduce
attributes:
label: Reproduction Link
description: Please provide a simple [codesandbox](https://codesandbox.io/s/vant-3-issue-template-8fuq5o) or GitHub repository link. Do not fill in invalid links, this will cause your issue to be closed directly.
validations:
required: true

- type: input
id: version
attributes:
label: Vant Version
description: Please fill in the version actually installed in node_modules/vant/package.json
placeholder: E.g. 3.2.0
validations:
required: true

- type: textarea
id: description
attributes:
label: Describe the Bug
validations:
required: true

- type: textarea
id: reproduce-steps
attributes:
label: Reproduce Steps
validations:
required: true

- type: input
id: browsers
attributes:
label: Device / Browser
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/template-6-feature-request-vant.en-US.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Feature Request
description: Use issue template to request a new feature.
title: "[Feature Request] Title"
labels: ["feature: need confirm"]
body:
- type: textarea
id: description
attributes:
label: What problem does this feature solve?
validations:
required: true

- type: textarea
id: api
attributes:
label: What does the proposed API look like?
description: Describe the new API, provide some code examples.
placeholder: |
```xml
<van-button some-prop="xxx" />
```
validations:
required: true
30 changes: 30 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
### Before submitting a pull request, please make sure the following is done:

1. Read the [contributing guide](https://github.com/vant-ui/vant/blob/3.x/.github/CONTRIBUTING.md).
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes (`npm test`).

#### Title Format

type(ComponentName?):commit message

Example:

- docs: fix typo in quickstart
- build: optimize build speed
- fix(Button): incorrect style
- feat(Button): add color prop

Allowed Types:

- fix
- feat
- docs
- perf
- test
- types
- build
- chore
- refactor
- breaking change
Loading

0 comments on commit 3dc4fdb

Please sign in to comment.