From 65b5207e27827e8136bf32c65a600b55f04e4af1 Mon Sep 17 00:00:00 2001 From: Wenju Gao Date: Wed, 19 Apr 2023 19:38:26 +0800 Subject: [PATCH] chore(template): make sure user documentation is updated as well (#722) --- .github/PULL_REQUEST_TEMPLATE.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4641e32..1099f2a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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. Please check your PR title with the below requirements: --> -- [ ] This PR title match the format: \(optional scope): \ +- [ ] This PR title match the format: `(optional scope): `. - [ ] 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. @@ -35,8 +35,13 @@ Provide more detailed info for review. If it is a perf type PR, perf data is sug en: zh(optional): -#### Which issue(s) this PR fixes: +#### (Optional) Which issue(s) this PR fixes: + +#### (Optional) The PR that updates user documentation: +