贡献指南

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

Issue 规范

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

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

目录结构

组件代码位于 src 目录下，每个组件一个独立的文件夹。

添加新组件时，请按照下面的目录结构组织文件，并在 中配置组件名称。

提交 PR

Pull Request 规范

规范

  • 当新增组件或者修改原有组件时，记得增加或者修改测试代码，保证代码的稳定
  • 在 PR 中请添加合适的描述，并关联相关的 Issue
  1. fork 主仓库，如果已经 fork 过，请同步主仓库的最新代码
  2. 基于 fork 后仓库的 dev 分支新建一个分支，比如 feature/button_color
  3. 在新分支上进行开发，开发完成后，提 Pull Request 到主仓库的 dev 分支
  4. Pull Request 会在 Review 通过后被合并到主仓库
  5. 等待 Vant 发布版本，一般是每周一次

同步最新代码

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