docs: move PR title format to contribution guide (#12114)
* docs: move PR title format to contribution guide * docs: fix path * docs: fix path * docs: update type
This commit is contained in:
@@ -15,7 +15,7 @@ Below are the guidelines for submitting feedback or code to Vant. Please take a
|
||||
|
||||
### Local development
|
||||
|
||||
Before developing locally, please make sure that [Node.js >= 14.19.0](https://nodejs.org) is installed in your development environment.
|
||||
Before developing locally, please make sure that [Node.js >= 18](https://nodejs.org) is installed in your development environment.
|
||||
|
||||
Follow the steps below to develop Vant components locally.
|
||||
|
||||
@@ -119,6 +119,37 @@ When submitting a Pull Request, please note:
|
||||
4. The pull request is merged into the main repository after the review is approved.
|
||||
5. Wait for Vant to release a new version, usually once a week.
|
||||
|
||||
### Pull Request Title Format
|
||||
|
||||
The title of the Pull Request should be in the following format:
|
||||
|
||||
```bash
|
||||
type(ComponentName?):commit message
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
- docs: fix typo in quickstart
|
||||
- build: optimize build speed
|
||||
- fix(Button): incorrect style
|
||||
- feat(Button): add color prop
|
||||
|
||||
Allowed Types:
|
||||
|
||||
- fix
|
||||
- feat
|
||||
- docs
|
||||
- perf
|
||||
- test
|
||||
- types
|
||||
- style
|
||||
- build
|
||||
- chore
|
||||
- release
|
||||
- refactor
|
||||
- breaking change
|
||||
- revert:
|
||||
|
||||
### Synchronize the latest code
|
||||
|
||||
Before submitting a Pull Request, please synchronize the latest code of the main repository according to the following process:
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
|
||||
### 本地开发
|
||||
|
||||
在进行本地开发前,请先确保你的开发环境中安装了 [Node.js >= 14.19.0](https://nodejs.org)。
|
||||
在进行本地开发前,请先确保你的开发环境中安装了 [Node.js >= 18](https://nodejs.org)。
|
||||
|
||||
按照下面的步骤操作,即可在本地开发 Vant 组件。
|
||||
|
||||
@@ -120,6 +120,37 @@ src
|
||||
4. Pull Request 会在 Review 通过后被合并到主仓库。
|
||||
5. 等待 Vant 发布新版本,一般是每周一次。
|
||||
|
||||
### Pull Request 标题格式
|
||||
|
||||
Pull Request 的标题应该遵循以下格式:
|
||||
|
||||
```bash
|
||||
type(ComponentName?):commit message
|
||||
```
|
||||
|
||||
示例:
|
||||
|
||||
- docs: fix typo in quickstart
|
||||
- build: optimize build speed
|
||||
- fix(Button): incorrect style
|
||||
- feat(Button): add color prop
|
||||
|
||||
可选的类型:
|
||||
|
||||
- fix
|
||||
- feat
|
||||
- docs
|
||||
- perf
|
||||
- test
|
||||
- types
|
||||
- style
|
||||
- build
|
||||
- chore
|
||||
- release
|
||||
- refactor
|
||||
- breaking change
|
||||
- revert:
|
||||
|
||||
### 同步最新代码
|
||||
|
||||
提 Pull Request 前,请依照下面的流程同步主仓库的最新代码:
|
||||
|
||||
Reference in New Issue
Block a user