Skip to content

Commit 2fb077f

Browse files
authored
Merge pull request #71 from Chisanan232/develop_adjust_pr_template
[CU-86er706un] Adjust the PR template to be more clear and readable.
2 parents 86e86b0 + dcffbf4 commit 2fb077f

File tree

1 file changed

+18
-25
lines changed

1 file changed

+18
-25
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,30 @@
1-
#### Pre-Checking
1+
[//]: # (The target why you modify something.)
2+
## _Target_
23

3-
‼️Please must read this section and check by yourself.
4-
⚠️Do NOT modify this section if it doesn't have any necessary reason.
4+
[//]: # (The summary what you did or your target.)
5+
* ### Task summary:
56

6-
Please verify the PR header should be satisfied below format:
7-
8-
[commit topic] (commit scope) <commit summary>
7+
N/A.
98

10-
* commit topic: The major topic of your modify. It could have multiple topics, e.g., [Breaking Change + Test].
11-
* commit scope: The scope in project of modify. It could have multiple scopes, e.g., (config + test).
12-
* 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.
9+
[//]: # (The task ID in ClickUp [project: https://app.clickup.com/9018752317/v/f/90183126979/90182605225] which maps this change.)
10+
* ### Task tickets:
1311

14-
Please refer to [GCR (Git Commit Rules)](../../.gitcommitrules) to get more detail about it.
12+
* Task ID: N/A.
13+
* Relative task IDs: N/A.
1514

16-
<hr>
15+
[//]: # (The key changes like demonstration, as-is & to-be, etc. for reviewers could be faster understand what it changes)
16+
* ### Key point change (optional):
1717

18-
### _Target_
18+
N/A.
1919

20-
* The target why you modify something.
2120

21+
[//]: # (What's the scope in project it would affect with your modify? For example, would it affect CI workflow? Or any feature usage? Please list all the items which may be affected.)
22+
## _Effecting Scope_
2223

23-
### _Modify Code Scope_
24+
* N/A.
2425

25-
* The more details of project scope which be modified, e.g., (refer to below 2 example items)
26-
* Which sub-packages or modules or objects or functions, etc., in **source code**.
27-
* Which sub-packages or modules or objects or functions, etc., in **test**.
2826

27+
[//]: # (The brief of major changes what your modify. Please list it.)
28+
## _Description_
2929

30-
### _Effecting Scope_
31-
32-
* What's the scope in project it would affect with your modify? The format could refer to previous one section.
33-
34-
35-
### _Description_
36-
37-
* the summary of your modify ...
30+
* N/A.

0 commit comments

Comments
 (0)