From 70ebeaaedcaed896cb2246eb72fd45c4ab3742f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=89=E5=92=B2=E6=99=BA=E5=AD=90?= Date: Fri, 17 Sep 2021 00:03:11 +0800 Subject: [PATCH] chore: update docs (#3443) --- .github/.git_commit_template.txt | 4 ++-- .github/pull_request_template.md | 2 +- README.md | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/.git_commit_template.txt b/.github/.git_commit_template.txt index 5040eb39b4..9e830bfdb2 100644 --- a/.github/.git_commit_template.txt +++ b/.github/.git_commit_template.txt @@ -1,2 +1,2 @@ -# [TYPE](SCOPE):DESCRIPTION#[ISSUE] -# example feat(button):add type 'button' for form usage #1234 +# [TYPE](SCOPE): [el-component-name] DESCRIPTION#[ISSUE] +# example: feat(components): [el-button] add type for form usage #1234 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 343c690c77..1f74be2373 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,5 @@ Please make sure these boxes are checked before submitting your PR, thank you! -- [ ] Make sure you follow Element's contributing guide [English](https://github.com/element-plus/element-plus/blob/master/.github/CONTRIBUTING.en-US.md) | ([中文](https://github.com/element-plus/element-plus/blob/master/.github/CONTRIBUTING.zh-CN.md) | [Español](https://github.com/element-plus/element-plus/blob/master/.github/CONTRIBUTING.es.md) | [Français](https://github.com/element-plus/element-plus/blob/master/.github/CONTRIBUTING.fr-FR.md)). +- [ ] Make sure you follow contributing guide [English](https://github.com/element-plus/element-plus/blob/master/.github/CONTRIBUTING.en-US.md) | ([中文](https://github.com/element-plus/element-plus/blob/master/.github/CONTRIBUTING.zh-CN.md) | [Español](https://github.com/element-plus/element-plus/blob/master/.github/CONTRIBUTING.es.md) | [Français](https://github.com/element-plus/element-plus/blob/master/.github/CONTRIBUTING.fr-FR.md)). - [ ] Make sure you are merging your commits to `dev` branch. - [ ] Add some descriptions and refer to relative issues for your PR. diff --git a/README.md b/README.md index e258eb45d6..26cdfa7b40 100644 --- a/README.md +++ b/README.md @@ -115,13 +115,13 @@ yarn cz Example ``` -[TYPE](SCOPE):DESCRIPTION#[ISSUE] -# example feat(components): add type 'button' for form usage #1234 +# [TYPE](SCOPE): [el-component-name] DESCRIPTION#[ISSUE] +# example: feat(components): [el-button] add type for form usage #1234 ``` ## Licence -ElementPlus is open source software licensed as +Element Plus is open source software licensed as [MIT](https://github.com/element-plus/element-plus/blob/master/LICENSE). ## Contributors