yutingNie
/
hertz
forked from cloudwego/hertz
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore(template): make sure user documentation is updated as well (#722)

This commit is contained in:
Wenju Gao 2023-04-19 19:38:26 +08:00 committed by GitHub
parent fcd5e6ccf5
commit 65b5207e27
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -21,9 +21,9 @@ The description of the title will be attached in Release Notes,
so please describe it from user-oriented, what this PR does / why we need it. so please describe it from user-oriented, what this PR does / why we need it.
Please check your PR title with the below requirements: Please check your PR title with the below requirements:
--> -->
- [ ] This PR title match the format: \<type\>(optional scope): \<description\> - [ ] This PR title match the format: `<type>(optional scope): <description>`.
- [ ] The description of this PR title is user-oriented and clear enough for others to understand. - [ ] The description of this PR title is user-oriented and clear enough for others to understand.
- [ ] Attach the PR updating the user documentation if the current PR requires user awareness at the usage level. [User docs repo](https://github.com/cloudwego/cloudwego.github.io).
#### (Optional) Translate the PR title into Chinese. #### (Optional) Translate the PR title into Chinese.
@ -35,8 +35,13 @@ Provide more detailed info for review. If it is a perf type PR, perf data is sug
en: en:
zh(optional): zh(optional):
#### Which issue(s) this PR fixes: #### (Optional) Which issue(s) this PR fixes:
<!-- <!--
Automatically closes linked issue when PR is merged. Automatically closes linked issue when PR is merged.
Eg: `Fixes #<issue number>`, or `Fixes (paste link of issue)`. Eg: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
--> -->
#### (Optional) The PR that updates user documentation:
<!--
If the current PR requires user awareness at the usage level, please submit a PR to update user docs. [User docs repo](https://github.com/cloudwego/cloudwego.github.io)
-->