Skip to content

Commit 2256119

Browse files
docs: add pull request template to improve contribution quality (#261)
Co-authored-by: ankaisen <51148505+ankaisen@users.noreply.github.com>
1 parent a3d45e2 commit 2256119

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## 📝 Pull Request Summary
2+
3+
Please provide a short summary explaining the purpose of this PR.
4+
5+
---
6+
7+
## ✅ What does this PR do?
8+
- Clearly describe the change introduced.
9+
- Mention the motivation or problem it solves.
10+
11+
---
12+
13+
## 🤔 Why is this change needed?
14+
- Explain the context or user impact.
15+
- Link any relevant issue or discussion.
16+
17+
---
18+
19+
## 🔍 Type of Change
20+
Please check what applies:
21+
22+
- [ ] Bug fix
23+
- [ ] New feature
24+
- [ ] Documentation update
25+
- [ ] Refactor / cleanup
26+
- [ ] Other (please explain)
27+
28+
---
29+
30+
## ✅ PR Quality Checklist
31+
32+
- [ ] PR title follows the conventional format (feat:, fix:, docs:)
33+
- [ ] Changes are limited in scope and easy to review
34+
- [ ] Documentation updated where applicable
35+
- [ ] No breaking changes (or clearly documented)
36+
- [ ] Related issues or discussions linked
37+
38+
---
39+
40+
## 📌 Optional
41+
42+
- [ ] Screenshots or examples added (if applicable)
43+
- [ ] Edge cases considered
44+
- [ ] Follow-up tasks mentioned

0 commit comments

Comments
 (0)