mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-05 05:42:44 +08:00
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:
neverland
GitHub
parent
95572cd3e4
commit
722c974ac4
41
.github/CONTRIBUTING.md
vendored
41
.github/CONTRIBUTING.md
vendored
@ -1,39 +1,4 @@
|
||||
# Contributing to Vant
|
||||
# Vant Contributing Guide
|
||||
|
||||
The following is a set of guidelines for contributing to Vant. Please spend several minutes in reading these guidelines before you create an issue or pull request.
|
||||
|
||||
Anyway, these are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.
|
||||
|
||||
## Opening an Issue
|
||||
|
||||
If you think you have found a bug, or have a new feature idea, please start by making sure it hasn't already been reported or fixed. You can search through existing issues and PRs to see if someone has reported one similar to yours.
|
||||
|
||||
Next, create a new issue that briefly explains the problem, and provides a bit of background as to the circumstances that triggered it, and steps to reproduce it.
|
||||
|
||||
## Submitting a Pull Request
|
||||
|
||||
It's welcomed to pull request, And there are some tips about that:
|
||||
|
||||
- Before working on a large change, it is best to open an issue first to discuss it with the maintainers.
|
||||
|
||||
- When in doubt, keep your pull requests small. To give a PR the best chance of getting accepted, don't bundle more than one feature or bug fix per pull request. It's always best to create two smaller PRs than one big one.
|
||||
|
||||
- When adding new features or modifying existing, please attempt to include tests to confirm the new behavior.
|
||||
|
||||
- Rebase before creating a PR to keep commit history clear.
|
||||
|
||||
- Add some descriptions and refer relative issues for you PR.
|
||||
|
||||
## Getting started
|
||||
|
||||
You will need [Node.js >= 14](https://nodejs.org) and [pnpm](https://pnpm.io).
|
||||
|
||||
```bash
|
||||
git clone git@github.com:vant-ui/vant.git
|
||||
|
||||
# Install dependencies
|
||||
pnpm i
|
||||
|
||||
# Start development
|
||||
pnpm dev
|
||||
```
|
||||
- [English Version](../packages/vant/docs/markdown/contribution.en-US.md)
|
||||
- [中文版](../packages/vant/docs/markdown/contribution.zh-CN.md)
|
||||
|
||||
31
.github/PULL_REQUEST_TEMPLATE.md
vendored
31
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,30 +1,3 @@
|
||||
### Before submitting a pull request, please make sure the following is done:
|
||||
Before submitting a pull request, please read the [contributing guide](https://vant-contrib.gitee.io/vant/#/en-US/contribution).
|
||||
|
||||
1. Read the [contributing guide](https://github.com/vant-ui/vant/blob/main/.github/CONTRIBUTING.md).
|
||||
2. If you've added code that should be tested, add tests.
|
||||
3. If you've changed APIs, update the documentation.
|
||||
4. Ensure the test suite passes (`npm test`).
|
||||
|
||||
#### Title Format
|
||||
|
||||
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
|
||||
- build
|
||||
- chore
|
||||
- refactor
|
||||
- breaking change
|
||||
在提交 pull request 之前，请阅读 [贡献指南](https://vant-contrib.gitee.io/vant/#/zh-CN/contribution)。
|
||||
|
||||
@ -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 前，请依照下面的流程同步主仓库的最新代码：
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user