You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+18-3Lines changed: 18 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,12 @@
2
2
3
3
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
4
4
5
-
Fixes # (issue)
5
+
**Related Issue:**
6
+
7
+
- Fixes #123 (use for bug fixes)
8
+
- Resolves #123 (use for feature implementations)
9
+
- Ref #123 (use for partial work or related changes)
10
+
- N/A (if no related issue)
6
11
7
12
## Type of change
8
13
@@ -11,7 +16,18 @@ Please delete options that are not relevant.
11
16
-[ ] Bug fix (non-breaking change which fixes an issue)
12
17
-[ ] New feature (non-breaking change which adds functionality)
13
18
-[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14
-
-[ ] This change requires a documentation update
19
+
-[ ] Enhancement (refactoring, style or performance improvement)
20
+
-[ ] Chore (maintenance tasks, dependency updates, or tooling changes that don't affect functionality)
21
+
-[ ] Documentation change (improvement to the Vitepress documentation or playground)
22
+
23
+
## Breaking Changes
24
+
25
+
If this is a breaking change, please describe:
26
+
27
+
- What functionality is affected
28
+
- How users should migrate their code
29
+
- What the new API/behavior looks like
30
+
- Version compatibility impact
15
31
16
32
# How Has This Been Tested?
17
33
@@ -26,6 +42,5 @@ Please describe the tests that you ran to verify your changes. Provide instructi
26
42
-[ ] I have commented my code, particularly in hard-to-understand areas
27
43
-[ ] I have made corresponding changes to the documentation
28
44
-[ ] I have run `pnpm lint` and my changes generate no new warnings
29
-
-[ ] I have added tests that prove my fix is effective or that my feature works
30
45
-[ ] New and existing unit tests pass locally with my changes
31
46
-[ ] Any dependent changes have been merged and published in downstream modules
0 commit comments