Add pull request template #16
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,35 @@ | ||||||
| # Pull Request Template ✨ | ||||||
|
|
||||||
| ## 📋 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. Minor suggestion because not all PR's resolve a problem (some add features).
Suggested change
|
||||||
| - 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. --> | ||||||
|
There was a problem hiding this comment. 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 |
||||||
| Closes/Fixes: # | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## ✅ 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. | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ### 🌟 Thank you for contributing! Together, we make this project better. | ||||||
|
There was a problem hiding this comment. 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. |
||||||
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.