Vant 开发指南
以下是关于向 Vant 提交反馈或的指南。在向 Vant 提交 issue 或者 PR 之前,请先花几分钟时间阅读以下。
遇到问题时,请先确认这个问题是否已经在 issue 中有记录或者已被修复
提 issue 时,请用简短的语言描述遇到的问题,并出现问题时的环境和复现步骤
按照下面的步骤操作,即可在本地开发 Vant 组件
# 克隆仓库 git clone git@github.com:youzan/vant.git # 安装依赖 cd vant && npm run bootstrap # 进入开发模式,浏览器访问 http://localhost:8080 npm run dev
仓库的组件位于 src 下,每个组件夹
docs 目录下是文档网站的,本地开发时可以在目录下运行 npm run dev 开启文档网站
项目主要目录如下:
vant ├─ build # 构建 ├─ docs # 文档 ├─ src # 组件 ├─ packages # 子包 ├─ test # 单测 └─ types # 类型
新组件时,请按照下面的目录结构组织,并在 vant.con.js 中配置组件
src └─ button ├─ demo # 示例 ├─ test # 单元测试 ├─ index.js # 组件入口 ├─ index.less # 组件样式 ├─ README.md # 英文文档 └─ README.zh-CN.md # 文档
提交 PR
如果遇到问题,建议保持你的 PR 足够小。保证 PR 只问题或只
当新增组件或者原有组件时,记得或者测试,保证的稳定
在 PR 中请合适的描述,并关联相关的 Issue
fork 主仓库,如果已经 fork 过,请同步主仓库的最新
基于 fork 后仓库的 dev 分支新建分支,比如feature/button_color
在新分支上进行开发,开发完成后,提 Pull Request 到主仓库的 dev 分支
Pull Request 会在 Review 通过后被合并到主仓库
等待 Vant 发布版本,一般是每周一次
提 Pull Request 前,请依照下面的流程同步主仓库的最新
# 主仓库到 remote,作为 fork 后仓库的上游仓库 git remote add upstream https://github.com/youzan/vant.git # 拉取主仓库最新 git fetch upstream # 切换至 dev 分支 git checkout dev # 合并主仓库 git merge upstream/dev