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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

AAYUSH-SPIDEY-SHARMA
Copy link

This PR introduces a PULL_REQUEST_TEMPLATE.md file to the repository. It aims to:

  • Provide a clear structure for contributors when submitting PRs.
  • Ensure consistency and quality across contributions.
  • Facilitate a smoother and faster review process by including essential details upfront.

🔗 Related Issue

Closes #15

This resolves the issue of missing PR guidelines by creating a standardized PR template that aligns with the repository's needs and improves contributor experience.


✅ 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: The PR template is self-documenting and does not require additional updates.
  • Creative Touch: Added a checklist item to encourage contributors to go beyond minimum expectations.

💡 Notes to Reviewers

  • Feedback on the checklist structure and sections is appreciated.
  • Let me know if you'd like additional examples or resources included in the template.

🌟 Thank you for reviewing this PR and helping improve the project!

Copy link
Collaborator

@d33bs d33bs left a comment

Choose a reason for hiding this comment

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

Nice job! I left some minor feedback, otherwise this was looking good to me!

---

## 🔗 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


## 📋 Description
<!-- Provide a concise yet clear summary of what this PR changes or adds. -->
- What problem does it solve?
Copy link
Collaborator

Choose a reason for hiding this comment

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

Minor suggestion because not all PR's resolve a problem (some add features).

Suggested change
- What problem does it solve?
- What does this PR change within the project?

@@ -0,0 +1,35 @@
# Pull Request Template ✨
Copy link
Collaborator

Choose a reason for hiding this comment

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

Consider removing this title, which would otherwise show up in the template each time it is used.

Comment on lines 33 to 35
---

### 🌟 Thank you for contributing! Together, we make this project better.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I really like the sentiment of this section! However, it could get repetitive if seen in multiple PR's. Consider moving the statement to an HTML comment near the beginning of the template as a message to the PR author.

@AAYUSH-SPIDEY-SHARMA
Copy link
Author

Thank you so much for taking the time to review my pull request and for your valuable feedback! I’ve made the following changes as per your suggestions:

Related Issue Section:

I’ve added the documentation link on using keywords in pull requests, as you recommended. I believe this will help in understanding how certain keywords impact the PR’s language.
Description Section:

I’ve updated the wording in the description to address your concern. Instead of focusing only on problems, I’ve included what this PR changes within the project, ensuring it covers both feature additions and fixes.
Pull Request Template Title:

I’ve removed the "Pull Request Template ✨" title, as suggested, to avoid redundancy in the PR body.
Thank You Section:

I’ve moved the "Thank you for contributing!" message to an HTML comment at the top of the template, so it’s visible to the PR author but not repeated in every PR.
I appreciate your insights, and I hope these changes align better with the expectations for the project. Please let me know if there's anything else I can improve.

Thanks again for your time and feedback!

@jring-o
Copy link
Collaborator

jring-o commented Jan 28, 2025

@d33bs

Looking to confirm that the changes align with your review before I merge.

Copy link
Collaborator

@eyermt eyermt left a comment

Choose a reason for hiding this comment

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

It seems the additional commits have addressed @d33bs comments. After review, this seems like a great initial pr template. Thank you for your contribution, and for taking the time to make these additional improvements.

@AAYUSH-SPIDEY-SHARMA
Copy link
Author

@eyermt Thank you for reviewing my PR. I look forward to working with you in the future!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add GitHub pull request template
4 participants