forked from opentiny/tiny-vue
docs: optimize contributing guide docs (#1382)
This commit is contained in:
GitHub
parent
355b4460a1
commit
6ad5420d8e
|
|
@ -38,9 +38,11 @@ The following information is required for the Issue of the new feature:
|
|||
|
||||
Before submitting pull request, please make sure that your submission is in line with the overall plan of TinyVue. Generally, issues that marked as [bug](https://github.com/opentiny/tiny-vue/labels/bug) are encouraged to submit pull requests. If you are not sure, you can create a [Discussion](https://github.com/opentiny/tiny-vue/discussions) for discussion.
|
||||
|
||||
### Pull Request specification
|
||||
### Pull Request Specification
|
||||
|
||||
- The commit message should be in the form of a `type(scope): description of the message`, e.g. `fix(vue-renderless): [scrollbar, action-menu] fix xxx bug`.
|
||||
#### Commit Message
|
||||
|
||||
The commit message should be in the form of a `type(scope): description of the message`, e.g. `fix(vue-renderless): [scrollbar, action-menu] fix xxx bug`.
|
||||
|
||||
1. type: must be one of build, chore, ci, docs, feat, fix, perf, refactor, revert, release, style, test, improvement.
|
||||
|
||||
|
|
@ -51,7 +53,7 @@ Before submitting pull request, please make sure that your submission is in line
|
|||
- The name of the folder to use: e.g.: `gulp, internals/playwright-config, sites`
|
||||
- The name of the component (lowercase, center dot): e.g.: `action-menu, alert ......`
|
||||
|
||||
- Pull Request title
|
||||
#### Pull Request Title
|
||||
|
||||
1. The specification of the title is the same as the commit information, which is entered in the form of `type(scope): description information`.
|
||||
|
||||
|
|
@ -67,7 +69,16 @@ Before submitting pull request, please make sure that your submission is in line
|
|||
- Supplement alet component test case: `test(alert): [alert] xxxxxxxxxxxxxx`
|
||||
- Fixed bug in alet component @opentiny/vue-renderless: `fix(vue-renderless/alert): [alert] xxxxxxxxxxxxxx`
|
||||
|
||||
Local startup steps:
|
||||
#### Pull Request Description
|
||||
|
||||
The PR description uses a template, and it is necessary to fill in the relevant information of the PR according to the template, mainly including:
|
||||
|
||||
- PR Checklist: Whether the Commit information is compliant with the specifications, whether it supplements the E2E test cases, and whether it supplements the documentation
|
||||
- PR Type: Bugfix / Feature / Code style update / Refactoring and so on
|
||||
- Issue Number
|
||||
- Does this PR introduce a breaking change?
|
||||
|
||||
### Local Startup Steps
|
||||
|
||||
- Click the Fork button in the upper right corner of the [TinyVue](https://github.com/opentiny/tiny-vue) code repository to Fork the upstream repository to the personal repository.
|
||||
- Clone personal repository to local.
|
||||
|
|
@ -94,7 +105,7 @@ pnpm dev
|
|||
pnpm dev:vue2
|
||||
```
|
||||
|
||||
To submit a PR:
|
||||
### Submit a PR
|
||||
|
||||
- Make sure that you have completed the steps in local startup and can visit [http://127.0.0.1:7130/](http://127.0.0.1:7130/) normally.
|
||||
- Synchronize upstream repository dev branch latest code: `git pull upstream dev`.
|
||||
|
|
@ -103,13 +114,14 @@ To submit a PR:
|
|||
- Submit according to [Commit Message Format](https://www.conventionalcommits.org/zh-hans/v1.0.0/) specification. PR that do not conform to the submission specification will not be merged.
|
||||
- Submit to remote repository: `git push origin branchName`.
|
||||
- Open the [Pull requests](https://github.com/opentiny/tiny-vue/pulls) link of the TinyVue code repository and click the New pull request button to submit the PR.
|
||||
- According to the PR template, please provide the following information: PR self-check items, PR type, related Issue ID, whether it is a destructive change.
|
||||
- Project Committer conducts Code Review and makes comments.
|
||||
- The PR author adjusts the code according to the opinion. Please note that when a branch initiates PR, the subsequent commit will be synchronized automatically, and there is no need to resubmit the PR.
|
||||
- Project administrator merges PR.
|
||||
|
||||
The contribution process is over, thank you for your contribution!
|
||||
|
||||
## Join OpenTiny community
|
||||
## Join OpenTiny Community
|
||||
|
||||
If you are interested in our open source project, you are welcome to join our open source community in the following ways.
|
||||
|
||||
|
|
|
|||
|
|
@ -40,7 +40,9 @@
|
|||
|
||||
### Pull Request 规范
|
||||
|
||||
- commit 信息要以 `type(scope): 描述信息` 的形式填写，例如 `fix(vue-renderless): [scrollbar, action-menu] fix xxx bug`。
|
||||
#### Commit 信息
|
||||
|
||||
commit 信息要以 `type(scope): 描述信息` 的形式填写，例如 `fix(vue-renderless): [scrollbar, action-menu] fix xxx bug`。
|
||||
|
||||
1. type: 必须是 build, chore, ci, docs, feat, fix, perf, refactor, revert, release, style, test, improvement 其中的一个。
|
||||
|
||||
|
|
@ -51,7 +53,7 @@
|
|||
- 用文件夹的名称: 比如: `gulp, internals/playwright-config, sites`
|
||||
- 组件的名称(小写，中划线): 比如: `action-menu, alert ......`
|
||||
|
||||
- Pull Request 的标题
|
||||
#### Pull Request 的标题
|
||||
|
||||
1. 标题的规范与 commit 信息一样，以`type(scope): 描述信息` 的形式填写。
|
||||
|
||||
|
|
@ -67,7 +69,16 @@
|
|||
- 补充 alet 组件测试用例: `test(alert): [alert] xxxxxxxxxxxxxx`
|
||||
- 修复 alet 组件 @opentiny/vue-renderless 下的缺陷: `fix(vue-renderless/alert): [alert] xxxxxxxxxxxxxx`
|
||||
|
||||
本地启动步骤：
|
||||
#### Pull Request 的描述
|
||||
|
||||
PR 描述使用了模板，需要按照模板填写 PR 相关信息，主要包括：
|
||||
|
||||
- PR 自检项：Commit 信息是够符合规范、是否补充了 E2E 测试用例、是否补充了文档
|
||||
- PR 类型：缺陷修复、新特性、代码格式调整、重构等
|
||||
- 关联的 Issue 编号
|
||||
- 是否包含破坏性变更
|
||||
|
||||
### 本地启动步骤
|
||||
|
||||
- 点击 [TinyVue](https://github.com/opentiny/tiny-vue) 代码仓库右上角的 Fork 按钮，将上游仓库 Fork 到个人仓库
|
||||
- Clone 个人仓库到本地
|
||||
|
|
@ -94,7 +105,7 @@ pnpm dev
|
|||
pnpm dev:vue2
|
||||
```
|
||||
|
||||
提交 PR 的步骤：
|
||||
### 提交 PR 的步骤
|
||||
|
||||
- 请确保你已经完成本地启动中的步骤，并能正常访问：[http://127.0.0.1:7130/](http://127.0.0.1:7130/)
|
||||
- 同步上游仓库 dev 分支最新代码：git pull upstream dev
|
||||
|
|
@ -103,6 +114,7 @@ pnpm dev:vue2
|
|||
- 遵循 [Commit Message Format](https://www.conventionalcommits.org/zh-hans/v1.0.0/) 规范进行提交，不符合提交规范的 PR 将不会被合并
|
||||
- 提交到远程仓库：git push origin branchName
|
||||
- 打开 TinyVue 代码仓库的 [Pull requests](https://github.com/opentiny/tiny-vue/pulls) 链接，点击 New pull request 按钮提交 PR
|
||||
- 按照 PR 模板补充相关信息，包括 PR 自检项、PR 类型、关联的 Issue 编号、是否是破坏性变更
|
||||
- 项目 Committer 进行 Code Review，并提出意见
|
||||
- PR 作者根据意见调整代码，请注意一个分支发起了 PR 后，后续的 commit 会自动同步，无需重新提交 PR
|
||||
- 项目管理员合并 PR
|
||||
|
|
|
|||
Loading…
Reference in New Issue