mirror of https://gitee.com/vant-contrib/vant.git synced 2025-06-03 20:29:15 +08:00

* docs: update repo struct

* docs: update

* docs: update

* docs: update

2021-11-29 17:37:34 +08:00

3.3 KiB

Raw Blame History

贡献指南

介绍

感谢你使用 Vant。

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

Issue 规范

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

参与开发

本地开发

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

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

# 克隆仓库
# 默认为 dev 分支，对应 Vant 3 的代码
# 如果需要在 Vant 2 上进行更改，请基于 2.x 分支进行开发
git clone git@github.com:youzan/vant.git

# 安装依赖
pnpm i

# 进入开发模式，浏览器访问 localhost
pnpm dev

目录结构

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

root
└─ packages
   ├─ vant        # 组件库
   ├─ vant-cli    # 脚手架
   ├─ vant-icons  # 图标库
   ├─ vant-use    # Composition API
   └─ ....        # 其他周边 npm 包

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

vant
├─ docs             # 文档
├─ src              # 组件源代码
├─ test             # 单测工具类
└─ vant.config.mjs  # 文档网站配置

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

src
└─ button
   ├─ demo             # 示例代码
   ├─ test             # 单元测试
   ├─ Component.tsx    # 组件
   ├─ index.ts         # 组件入口
   ├─ index.less       # 样式
   ├─ var.less         # 样式变量
   ├─ README.md        # 英文文档
   └─ README.zh-CN.md  # 中文文档

提交 PR

Pull Request 规范

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

规范

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

Pull Request 流程

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

3.3 KiB Raw Blame History Unescape Escape