Skip to content

Commit 2f04140

Browse files
committed
chore(pull_requests_template): various improvements
1 parent f7cf7e5 commit 2f04140

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

.github/pull_request_template.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22

33
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.
44

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)
611

712
## Type of change
813

@@ -11,7 +16,18 @@ Please delete options that are not relevant.
1116
- [ ] Bug fix (non-breaking change which fixes an issue)
1217
- [ ] New feature (non-breaking change which adds functionality)
1318
- [ ] 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
1531

1632
# How Has This Been Tested?
1733

@@ -26,6 +42,5 @@ Please describe the tests that you ran to verify your changes. Provide instructi
2642
- [ ] I have commented my code, particularly in hard-to-understand areas
2743
- [ ] I have made corresponding changes to the documentation
2844
- [ ] 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
3045
- [ ] New and existing unit tests pass locally with my changes
3146
- [ ] Any dependent changes have been merged and published in downstream modules

0 commit comments

Comments
 (0)