贡献指南

以下是关于向 Vant 提交反馈或代码的指南。在向 Vant 提交 issue 或者 PR 之前，请先花几分钟时间阅读以下内容。

Issue 规范

  • 遇到问题时，请先确认这个问题是否已经在 issue 中有记录或者已被修复。
  • 提 issue 时，请用简短的语言描述遇到的问题，并添加出现问题时的环境和复现步骤。

本地开发

在进行本地开发前，请先确保你的开发环境中安装了 Node.js >= 14.19.0。

按照下面的步骤操作，即可在本地开发 Vant 组件。

仓库的不同分支对应不同的 Vant 版本，请切换到对应分支进行开发：

  • dev 分支对应 Vant 4 版本，适用于 Vue 3
  • 2.x 分支对应 Vant 2 版本，适用于 Vue 2

镜像仓库仅用于加快国内的访问速度，请勿在镜像仓库中提 issue 和 Pull Request。

目录结构

Vant 采用 monorepo 进行代码管理，所有子包在 packages 目录下:

其中，vant 目录为组件库的核心代码：

  1. vant
  2. ├─ docs             # 文档
  3. ├─ src              # 组件源代码
  4. ├─ test             # 单测工具类

src 目录包含各个组件的源码，每个文件夹对应一个组件：

代码规范

  • 确保代码可以通过仓库的 ESLint 校验。
  • 确保代码格式是规范的，使用 prettier 进行代码格式化。
  • 确保没有使用超出兼容性范围的 API，比如 async/await。

提交 PR

如果你是第一次在 GitHub 上提 Pull Request ，可以阅读下面这两篇文章来学习：

Pull Request 规范

在提交 Pull Request 时，请注意：

  • 如果遇到问题，建议保持你的 PR 足够小。保证一个 PR 只解决单个问题、添加单个功能。
  • 当新增组件或者修改原有组件时，记得增加或者修改对应的单元测试，保证代码的稳定。
  • 在 PR 中请添加合适的描述，并关联相关的 Issue。

Pull Request 流程

  1. 基于 fork 后仓库的 dev 分支新建一个分支，比如 feature/button_color。
  2. 在新分支上进行开发，开发完成后，提 Pull Request 到主仓库的 dev 分支。
  3. Pull Request 会在 Review 通过后被合并到主仓库。
  4. 等待 Vant 发布新版本，一般是每周一次。

提 Pull Request 前，请依照下面的流程同步主仓库的最新代码：

  1. # 添加主仓库到 remote，作为 fork 后仓库的上游仓库
  2. git remote add upstream git@github.com:vant-ui/vant.git
  5. git fetch upstream
  7. # 切换至 dev 分支
  8. git checkout dev
  10. # 合并主仓库代码