感谢你使用 Vant。
以下是关于向 Vant 提交反馈或代码的指南。在向 Vant 提交 issue 或者 PR 之前,请先花几分钟时间阅读以下文字。
按照下面的步骤操作,即可在本地开发 Vant 组件。
# 克隆仓库
# 默认为 dev 分支,包含 Vant 3 的代码
# 如果需要在 Vant 2 上进行更改,请基于 2.x 分支进行开发
git clone git@github.com:youzan/vant.git
# 安装依赖
cd vant && yarn
# 进入开发模式,浏览器访问 http://localhost:8080
npm run dev
项目的主要目录结构如下所示:
vant
├─ docs # 文档
├─ packages # 基础包
├─ src # 组件源代码
├─ test # 单测工具类
└─ vant.config.js # 文档网站配置
组件代码位于 src 目录下,每个组件一个独立的文件夹。
添加新组件时,请按照下面的目录结构组织文件,并在 vant.config.js 中配置组件名称。
src
└─ button
├─ demo # 示例代码
├─ test # 单元测试
├─ Component.ts # 组件
├─ index.ts # 组件入口
├─ index.less # 样式
├─ var.less # 样式变量
├─ README.md # 英文文档
└─ README.zh-CN.md # 中文文档
如果你是第一次在 GitHub 上提 Pull Request ,可以阅读下面这两篇文章来学习:
提 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