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

Add pull request template #16

Merged
merged 4 commits into from
Feb 12, 2025
Merged
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
32 changes: 32 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!-- 🌟 Thank you for contributing! Together, we make this project better. -->

## πŸ“‹ Description
<!-- Provide a concise yet clear summary of what this PR changes or adds. -->
- What does this PR change within the project?
- Why is it necessary?
- Highlight any interesting or unique aspects of the change.

---

## πŸ”— Related Issue
<!-- Link the issue this PR addresses and include a brief explanation if needed. -->
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding a documentation here about the keyword usage within pull requests and how this impacts the language used below within this section. This link might be informative within the HTML comment. https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests

<!-- Use keywords like "Closes #", "Fixes #", or "Resolves #" to automatically link and close the issue when this PR is merged. -->
<!-- More details: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests -->

---

## βœ… Checklist
Before submitting your PR, ensure the following:
- [ ] πŸ“„ **Clear Description**: I have provided a detailed description of the changes made.
- [ ] πŸ–‡οΈ **Issue Linked**: I have linked the correct issue and included its number above.
- [ ] πŸš€ **Functionality Tested**: I have thoroughly tested the changes, and they work as intended.
- [ ] πŸ” **Duplicate Check**: I have ensured there are no other PRs addressing the same issue or feature.
- [ ] πŸ“š **Documentation Updated**: I have updated relevant documentation (if applicable).
- [ ] ✨ **Creative Touch**: I’ve added value beyond the minimal requirements to enhance quality and readability.

---

## πŸ’‘ Notes to Reviewers (Optional)
<!-- Add any additional context, insights, or areas for reviewers to focus on. -->
- Highlight complex parts or reasoning behind specific decisions.
- Suggest areas where feedback is especially welcome.