From 84e67780df29e75e636286b25bbb3dd41d460c74 Mon Sep 17 00:00:00 2001 From: Chisanan232 Date: Wed, 17 Aug 2022 07:38:09 +0800 Subject: [PATCH 1/2] [New Feature] (config) Add a new template content with markdown for PR. [skip ci] --- .../pull_request_template.md | 37 +++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 00000000..0b638686 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,37 @@ +#### Pre-Checking + +‼️Please must read this section and check by yourself. +⚠️Do NOT modify this section if it doesn't have any necessary reason. + +Please verify the PR header should be satisfied below format: + + [commit topic] (commit scope) + +* commit topic: The major topic of your modify. It could have multiple topics, e.g., [Breaking Change + Test]. +* commit scope: The scope in project of modify. It could have multiple scopes, e.g., (config + test). +* commit summary: Summary of the commits. It should be clear that the target, the KEY POINT why you modify it or what you resolve, etc. + +Please refer to [GCR (Git Commit Rules) of SmoothCrawler-Cluster](../../.gitcommitrules) to get more detail about it. + +
+ +### _Target_ + +* The target why you modify something. + + +### _Modify Code Scope_ + +* The more details of project scope which be modified, e.g., (refer to below 2 example items) +* Which sub-packages or modules or objects or functions, etc., in **source code**. +* Which sub-packages or modules or objects or functions, etc., in **test**. + + +### _Effecting Scope_ + +* What's the scope in project it would affect with your modify? The format could refer to previous one section. + + +### _Description_ + +* the summary of your modify ... From e35ce2667c70f1f48d2f150cd5ca92dcf2cbff35 Mon Sep 17 00:00:00 2001 From: Chisanan232 Date: Wed, 17 Aug 2022 09:12:16 +0800 Subject: [PATCH 2/2] [Breaking Change] (config) Modify the link name about GCR. --- .github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 0b638686..8c032f3a 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -11,7 +11,7 @@ Please verify the PR header should be satisfied below format: * commit scope: The scope in project of modify. It could have multiple scopes, e.g., (config + test). * commit summary: Summary of the commits. It should be clear that the target, the KEY POINT why you modify it or what you resolve, etc. -Please refer to [GCR (Git Commit Rules) of SmoothCrawler-Cluster](../../.gitcommitrules) to get more detail about it. +Please refer to [GCR (Git Commit Rules)](../../.gitcommitrules) to get more detail about it.