Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(pr-template): Enhance PR Template for Clarity and Ease of Use #713

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 29 additions & 9 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,33 @@
<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
v ✰ Thanks for creating a PR! ✰
v If your PR doesn't close an issue, that's OK! Just remove the Closes: #XXX line!
☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -->
<!-- 🚀 Thanks for contributing! Please complete the details below to help us review your PR. -->

Closes: #XXX
> *Be noted that XXX is the issue ID*
### Closes: #XXX
> _Replace `XXX` with the issue ID. Remove if not applicable._

## What is the purpose of the change
---

> Add a description of the overall background and high level changes that this PR introduces
### 🔍 Purpose of the Change
> Briefly describe the purpose and high-level impact of this PR.

*(E.g.: This pull request improves documentation of area A by adding ....)*
---

### 🔄 Overview of Changes
> Select the types of changes included in this PR:

- [ ] Code Enhancements
- [ ] Documentation Updates
- [ ] Bug Fixes
- [ ] New Features
- [ ] Other (please specify):

> _Example: If this PR only includes documentation updates, check the box next to "Documentation Updates"._

---

### ✅ Checklist
- [ ] Code meets project standards.
- [ ] Relevant documentation updated (if applicable).
- [ ] Tests added or updated (if applicable).

---

Thank you! 🙌