开发指南

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

    Issue 规范

    • 遇到问题时，请先确认这个问题已经在 issue 中有记录或者已被修复
    • 提 Issue 时，请用简短的语言描述遇到的问题，并添加出现问题时的环境和复现步骤
    • 如果遇到问题，建议保持你的 PR 足够小。保证一个 PR 只解决一个问题或只添加一个功能
    • 当新增组件或者修改原有组件时，记得增加或者修改测试代码，保证代码的稳定
    • 在 PR 中请添加合适的描述，并关联相关的 Issue

    Pull Request 流程

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

    初始化项目

    浏览器访问 就可以看到所有组件的示例了。

    • 仓库的组件代码位于 packages 下，每个组件一个文件夹
    • docs 目录下是文档网站的代码，本地开发时可以在目录下运行 npm run dev 开启文档网站项目目录大致如下：

    添加新组件