Vant3 貢獻指南

介紹

感謝你使用 Vant。

以下是關(guān)于向 Vant 提交反饋或代碼的指南。在向 Vant 提交 issue 或者 PR 之前，請先花幾分鐘時間閱讀以下文字。

Issue 規(guī)范

• 遇到問題時，請先確認這個問題是否已經(jīng)在 issue 中有記錄或者已被修復(fù)
• 提 issue 時，請用簡短的語言描述遇到的問題，并添加出現(xiàn)問題時的環(huán)境和復(fù)現(xiàn)步驟

參與開發(fā)

本地開發(fā)

按照下面的步驟操作，即可在本地開發(fā) Vant 組件。

# 克隆倉庫
# 默認為 dev 分支，包含 Vant 3 的代碼
# 如果需要在 Vant 2 上進行更改，請基于 2.x 分支進行開發(fā)
git clone git@github.com:youzan/vant.git

# 安裝依賴
cd vant && yarn

# 進入開發(fā)模式，瀏覽器訪問 http://localhost:8080
npm run dev

目錄結(jié)構(gòu)

項目的主要目錄結(jié)構(gòu)如下所示：

vant
├─ docs            # 文檔
├─ packages        # 基礎(chǔ)包
├─ src             # 組件源代碼
├─ test            # 單測工具類
└─ vant.config.js  # 文檔網(wǎng)站配置

組件代碼位于 src 目錄下，每個組件一個獨立的文件夾。

組件目錄結(jié)構(gòu)

添加新組件時，請按照下面的目錄結(jié)構(gòu)組織文件，并在 vant.config.js 中配置組件名稱。

src
└─ button
   ├─ demo             # 示例代碼
   ├─ test             # 單元測試
   ├─ Component.ts     # 組件
   ├─ index.ts         # 組件入口
   ├─ index.less       # 樣式
   ├─ var.less         # 樣式變量
   ├─ README.md        # 英文文檔
   └─ README.zh-CN.md  # 中文文檔

提交 PR

Pull Request 規(guī)范

如果你是第一次在 GitHub 上提 Pull Request ，可以閱讀下面這兩篇文章來學(xué)習(xí)：

• 如何優(yōu)雅地在 GitHub 上貢獻代碼
• 第一次參與開源

規(guī)范

• 如果遇到問題，建議保持你的 PR 足夠小。保證一個 PR 只解決一個問題或只添加一個功能
• 當新增組件或者修改原有組件時，記得增加或者修改測試代碼，保證代碼的穩(wěn)定
• 在 PR 中請?zhí)砑雍线m的描述，并關(guān)聯(lián)相關(guān)的 Issue

Pull Request 流程

1. fork 主倉庫，如果已經(jīng) fork 過，請同步主倉庫的最新代碼
2. 基于 fork 后倉庫的 dev 分支新建一個分支，比如 feature/button_color
3. 在新分支上進行開發(fā)，開發(fā)完成后，提 Pull Request 到主倉庫的 dev 分支
4. Pull Request 會在 Review 通過后被合并到主倉庫
5. 等待 Vant 發(fā)布版本，一般是每周一次

同步最新代碼

提 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