-
Notifications
You must be signed in to change notification settings - Fork 43
Expand file tree
/
Copy pathpull_request_template.md
More file actions
144 lines (116 loc) · 2.77 KB
/
pull_request_template.md
File metadata and controls
144 lines (116 loc) · 2.77 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
<!--
Thank you for opening a Pull Request 🚀
Please fill out this template as completely as possible.
Clear PRs = faster reviews = better software.
-->
# 📌 Summary
<!--
Briefly explain what this PR does and why it is needed.
Focus on the intent, not the implementation details.
-->
---
## 🎯 Related Issues / Tickets
<!--
Link any related issues, tickets, or discussions.
Use GitHub keywords to auto-close issues when merged.
-->
- Closes #
- Related to #
---
## 🧩 Scope of Changes
<!--
Describe the scope and nature of the changes at a high level.
-->
- Added:
- Updated:
- Removed:
- Refactored:
---
## 🛠️ Technical Details
<!--
Explain important technical decisions, trade-offs, or architecture changes.
Include anything that may not be obvious from reading the code.
-->
---
## 🔍 How to Test
<!--
Provide clear, step-by-step instructions to test this change.
Assume the reviewer is unfamiliar with the context.
-->
1.
2.
3.
---
## 🧪 Test Coverage
<!--
Indicate what types of tests were added or updated.
-->
- [ ] Unit tests
- [ ] Integration tests
- [ ] End-to-end (E2E) tests
- [ ] Manual testing only (explain why)
---
## 📸 Screenshots / Recordings (UI changes only)
<!--
Include before/after screenshots or short videos if this PR affects the UI.
-->
---
## ⚠️ Breaking Changes
<!--
List any breaking changes and required migration steps.
If none, state "None".
-->
- None
---
## 🚀 Deployment Notes
<!--
Anything required or important during deployment:
- environment variables
- database migrations
- feature flags
- deployment order
-->
- [ ] Requires database migration
- [ ] Requires environment variable changes
- [ ] Requires feature flag toggle
- [ ] No special deployment steps
Details:
---
## 🔒 Security Considerations
<!--
Mention any security-related implications or validations.
-->
- [ ] No security impact
- [ ] Input validation changes
- [ ] Authentication / authorization changes
- [ ] Sensitive data handling changes
---
## 📈 Performance Impact
<!--
Describe any performance considerations, improvements, or regressions.
-->
- [ ] No performance impact
- [ ] Improves performance
- [ ] Potential performance regression (explain)
---
## 📝 Notes for Reviewers
<!--
Highlight areas that need special attention or context for reviewers.
-->
---
## ✅ Checklist
<!--
Confirm all items before requesting review.
-->
- [ ] I have self-reviewed my code
- [ ] Code follows project standards and conventions
- [ ] Tests have been added or updated
- [ ] Documentation has been updated (if applicable)
- [ ] No new warnings or lint errors
- [ ] Changes are backward compatible or breaking changes are documented
---
## 📚 Additional Context
<!--
Any extra information that may help reviewers understand this PR.
Links, references, or follow-up work.
-->