Skip to content

Commit 5a12fbc

Browse files
committed
feat: add PR templates
- Add YAML-based PR template with: - Required issue references - Detailed change descriptions - Testing checklist - Breaking change section - Add markdown PR template for compatibility
1 parent 3dde0b1 commit 5a12fbc

File tree

2 files changed

+148
-0
lines changed

2 files changed

+148
-0
lines changed

.github/pull_request_template.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## Related Issues
2+
<!-- List any related issues this PR addresses using #issue-number -->
3+
Fixes #
4+
5+
## Changes Made
6+
<!-- Describe the changes you've made -->
7+
-
8+
-
9+
-
10+
11+
## Testing Done
12+
<!-- Describe the testing you've performed -->
13+
- [ ] Added unit tests
14+
- [ ] Added integration tests
15+
- [ ] Manually tested
16+
- [ ] Updated test documentation
17+
18+
## Checklist
19+
<!-- Please check all that apply -->
20+
- [ ] I have read the CONTRIBUTING guidelines
21+
- [ ] My code follows the project's style guidelines
22+
- [ ] I have added tests that prove my fix/feature works
23+
- [ ] I have updated the documentation accordingly
24+
- [ ] All new and existing tests passed
25+
- [ ] My commits follow the project's commit message convention
26+
27+
## Type of Change
28+
<!-- What type of change does this PR introduce? -->
29+
- [ ] Feature
30+
- [ ] Bug Fix
31+
- [ ] Documentation
32+
- [ ] Performance Improvement
33+
- [ ] Code Style Update
34+
- [ ] Refactoring
35+
- [ ] CI/CD
36+
- [ ] Other
37+
38+
## Breaking Change
39+
<!-- Does this PR introduce a breaking change? -->
40+
- [ ] No
41+
- [ ] Yes (please describe below)
42+
43+
### Breaking Change Description
44+
<!-- If this PR introduces a breaking change, describe it and migration steps -->
45+
46+
## Additional Information
47+
<!-- Add any other context about the PR here -->

.github/pull_request_template.yml

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
name: Pull Request
2+
description: Create a pull request
3+
title: "[PR]: "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for creating this pull request! Please ensure you've read our contributing guidelines.
9+
10+
- type: input
11+
id: related-issues
12+
attributes:
13+
label: Related Issues
14+
description: List any related issues this PR addresses
15+
placeholder: "#123, #456"
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: changes
21+
attributes:
22+
label: Changes Made
23+
description: Describe the changes you've made
24+
placeholder: |
25+
- Added feature X
26+
- Fixed bug Y
27+
- Updated documentation for Z
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: testing
33+
attributes:
34+
label: Testing Done
35+
description: Describe the testing you've performed
36+
placeholder: |
37+
- Added unit tests for X
38+
- Added integration tests for Y
39+
- Manually tested scenario Z
40+
validations:
41+
required: true
42+
43+
- type: checkboxes
44+
id: checklist
45+
attributes:
46+
label: Pull Request Checklist
47+
description: Please check all that apply
48+
options:
49+
- label: I have read the CONTRIBUTING guidelines
50+
required: true
51+
- label: My code follows the project's style guidelines
52+
required: true
53+
- label: I have added tests that prove my fix/feature works
54+
required: true
55+
- label: I have updated the documentation accordingly
56+
required: true
57+
- label: All new and existing tests passed
58+
required: true
59+
- label: My commits follow the project's commit message convention
60+
required: true
61+
62+
- type: dropdown
63+
id: type
64+
attributes:
65+
label: Type of Change
66+
description: What type of change does this PR introduce?
67+
options:
68+
- Feature
69+
- Bug Fix
70+
- Documentation
71+
- Performance Improvement
72+
- Code Style Update
73+
- Refactoring
74+
- CI/CD
75+
- Other
76+
validations:
77+
required: true
78+
79+
- type: dropdown
80+
id: breaking
81+
attributes:
82+
label: Breaking Change
83+
description: Does this PR introduce a breaking change?
84+
options:
85+
- "No"
86+
- "Yes"
87+
validations:
88+
required: true
89+
90+
- type: textarea
91+
id: breaking-description
92+
attributes:
93+
label: Breaking Change Description
94+
description: If this PR introduces a breaking change, describe it and migration steps
95+
placeholder: Describe the breaking changes and how to migrate...
96+
97+
- type: textarea
98+
id: additional
99+
attributes:
100+
label: Additional Information
101+
description: Add any other context about the PR here

0 commit comments

Comments
 (0)