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
2023-07-23 19:10:04 +08:00
parent 95572cd3e4
commit 722c974ac4
4 changed files with 69 additions and 69 deletions
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -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)
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -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)。