-
-
Notifications
You must be signed in to change notification settings - Fork 15
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
base: main
Are you sure you want to change the base?
Add pull request template #16
Conversation
There was a problem hiding this 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. --> |
There was a problem hiding this comment.
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
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
||
## 📋 Description | ||
<!-- Provide a concise yet clear summary of what this PR changes or adds. --> | ||
- What problem does it solve? |
There was a problem hiding this comment.
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).
- What problem does it solve? | |
- What does this PR change within the project? |
.github/PULL_REQUEST_TEMPLATE.md
Outdated
@@ -0,0 +1,35 @@ | |||
# Pull Request Template ✨ |
There was a problem hiding this comment.
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.
.github/PULL_REQUEST_TEMPLATE.md
Outdated
--- | ||
|
||
### 🌟 Thank you for contributing! Together, we make this project better. |
There was a problem hiding this comment.
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.
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. 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. I’ve removed the "Pull Request Template ✨" title, as suggested, to avoid redundancy in the PR body. 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. Thanks again for your time and feedback! |
Looking to confirm that the changes align with your review before I merge. |
There was a problem hiding this 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.
@eyermt Thank you for reviewing my PR. I look forward to working with you in the future! |
This PR introduces a
PULL_REQUEST_TEMPLATE.md
file to the repository. It aims to:🔗 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:
💡 Notes to Reviewers
🌟 Thank you for reviewing this PR and helping improve the project!