Skip to content

Commit 7d0e687

Browse files
authored
Create pull_request_template.md
1 parent a71618f commit 7d0e687

1 file changed

Lines changed: 139 additions & 0 deletions

File tree

.github /pull_request_template.md

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
# 🛠️ Pull Request Template
2+
3+
## 🏷️ PR Type
4+
<!--
5+
Select the type of PR (check one):
6+
- [ ] 🐞 Bug Fix
7+
- [ ] ✨ Feature
8+
- [ ] 🛠️ Improvement / Refactor
9+
- [ ] 📚 Documentation
10+
-->
11+
12+
---
13+
14+
## 🔗 Related Issue
15+
<!--
16+
Link the GitHub issue this PR closes (if applicable).
17+
Example: `Closes #123`
18+
-->
19+
- Closes #.
20+
21+
---
22+
23+
## 📝 Rationale / Motivation
24+
<!--
25+
Explain why this change is necessary.
26+
- What problem does it solve?
27+
- How does it improve the project?
28+
- Any relevant context for reviewers.
29+
-->
30+
31+
---
32+
33+
## ✨ Description of Changes
34+
<!--
35+
Summarize changes with details:
36+
- What files/components were modified
37+
- Any new functionality added
38+
- Refactoring, cleanup, or optimizations
39+
- Nested bullet points for clarity
40+
-->
41+
42+
- **Frontend**
43+
- Component A updated
44+
- Component B refactored
45+
- **Backend / API**
46+
- Endpoint X optimized
47+
- Validation added
48+
- **Documentation**
49+
- Updated README / Added usage example
50+
51+
---
52+
53+
## 🧪 Testing Instructions
54+
<!--
55+
Step-by-step guide to test this PR:
56+
1. Setup or dependencies needed
57+
2. Actions to perform
58+
3. Expected results
59+
4. Mention automated tests coverage
60+
-->
61+
62+
1. Pull branch and run `npm install`
63+
2. Start local server with `npm start`
64+
3. Navigate to `/feature-page` and verify functionality
65+
4. Run tests: `npm test` (all should pass)
66+
5. Verify edge cases
67+
68+
---
69+
70+
## 👀 Impact Assessment
71+
<!--
72+
Analyze the impact of this PR:
73+
- User-facing changes (UI / UX)
74+
- Backend/API changes
75+
- Performance considerations
76+
- Security implications
77+
- Cross-browser / device impact
78+
-->
79+
80+
---
81+
82+
## 🖼️ Screenshots / GIFs (if applicable)
83+
<!--
84+
Add screenshots or GIFs demonstrating user-facing changes
85+
-->
86+
87+
---
88+
89+
## ⚡ Checklist
90+
- [ ] Code follows project’s coding style and guidelines
91+
- [ ] Changes are tested locally
92+
- [ ] Automated tests added/updated
93+
- [ ] Documentation updated (if applicable)
94+
- [ ] User-facing changes are documented
95+
- [ ] Related issue linked
96+
- [ ] No new warnings/errors introduced
97+
- [ ] All reviewers guidance addressed
98+
99+
---
100+
101+
## 🔖 Reviewer Notes
102+
<!--
103+
Tips for reviewers to focus on critical areas:
104+
- Areas with complex logic
105+
- Known limitations or trade-offs
106+
- Optional testing scenarios
107+
-->
108+
109+
---
110+
111+
## ⚠️ Breaking Changes
112+
<!--
113+
Document any backward-incompatible changes:
114+
- Public APIs
115+
- Config / env variables
116+
- Existing workflows
117+
-->
118+
119+
---
120+
121+
## 🏆 Optional Enhancements / Future Work
122+
<!--
123+
Ideas or improvements that can be implemented later:
124+
- UI improvements
125+
- Additional validations
126+
- Performance optimizations
127+
- Feature expansions
128+
-->
129+
130+
---
131+
132+
## 🎯 Priority / Impact Level
133+
<!--
134+
Indicate the priority and expected impact:
135+
- Low / Medium / High
136+
- Helps maintainers understand urgency and importance
137+
-->
138+
- Priority: High
139+
- Impact: Medium

0 commit comments

Comments
 (0)