Created pull request template #19
Conversation
There was a problem hiding this comment.
Hi @BlackBond06! :) The template is off to a good start! :) I gave some suggestions on how to improve it.
Future tip: Don't do a pull request in a project unless the maintainer has already assigned it to you. It's
open source etiquette
| Please provide a brief description of the change and mention the issue it addresses.Also, include relevant motivation and context. List any dependencies that are required for this change. | ||
|
|
||
| Please delete options that are not relevant and please make sure that you X the appropriate boxes. |
There was a problem hiding this comment.
[suggestion] It'd be best to comment out the instructions so that contributors can work find space to add this information.
| Please provide a brief description of the change and mention the issue it addresses.Also, include relevant motivation and context. List any dependencies that are required for this change. | |
| Please delete options that are not relevant and please make sure that you X the appropriate boxes. | |
| <!-- Please provide a brief description of the change and mention the issue it addresses.Also, include relevant motivation and context. List any dependencies that are required for this change. | |
| Please delete options that are not relevant and please make sure that you X the appropriate boxes. | |
| --> |
| ## Screenshots (if applicable) | ||
| Include screenshots or GIFs showcasing the changes made, especially if they impact the visual aspects of the app. | ||
|
|
||
| ## Testing Done | ||
|
|
||
| Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Also, mention any important details about your testing setup. If you used a testing tool like Jest or Mocha in JavaScript, please let us know. |
There was a problem hiding this comment.
| ## Screenshots (if applicable) | |
| Include screenshots or GIFs showcasing the changes made, especially if they impact the visual aspects of the app. | |
| ## Testing Done | |
| Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Also, mention any important details about your testing setup. If you used a testing tool like Jest or Mocha in JavaScript, please let us know. | |
| ## Screenshots (if applicable) | |
| <!-- Include screenshots or GIFs showcasing the changes made, especially if they impact the visual aspects of the app. | |
| --> | |
| ## Testing Done | |
| <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Also, mention any important details about your testing setup. If you used a testing tool like Jest or Mocha in JavaScript, please let us know. | |
| --> |
| ## Checklist | ||
|
|
||
| - [ ] My code follows the style guidelines of this project | ||
| - [ ] I have performed a self-review of my own code | ||
| - [ ] I have commented my code, particularly in hard-to-understand areas | ||
| - [ ] I have made corresponding changes to the documentation | ||
| - [ ] My changes generate no new warnings | ||
| - [ ] I have added tests that prove my fix is effective or that my feature works | ||
| - [ ] New and existing unit tests pass locally with my changes | ||
| - [ ] Any dependent changes have been merged and published in downstream modules | ||
| - [ ] I have checked my code and corrected any misspellings |
There was a problem hiding this comment.
| ## Checklist | |
| - [ ] My code follows the style guidelines of this project | |
| - [ ] I have performed a self-review of my own code | |
| - [ ] I have commented my code, particularly in hard-to-understand areas | |
| - [ ] I have made corresponding changes to the documentation | |
| - [ ] My changes generate no new warnings | |
| - [ ] I have added tests that prove my fix is effective or that my feature works | |
| - [ ] New and existing unit tests pass locally with my changes | |
| - [ ] Any dependent changes have been merged and published in downstream modules | |
| - [ ] I have checked my code and corrected any misspellings | |
| ## Checklist | |
| <-- Check all that apply --> | |
| - [ ] My code follows the style guidelines of this project | |
| - [ ] I have performed a self-review of my own code | |
| - [ ] I have commented my code, particularly in hard-to-understand areas | |
| - [ ] I have made corresponding changes to the documentation | |
| - [ ] My changes generate no new warnings | |
| - [ ] I have added tests that prove my fix is effective or that my feature works | |
| - [ ] New and existing unit tests pass locally with my changes | |
| - [ ] Any dependent changes have been merged and published in downstream modules | |
| - [ ] I have checked my code and corrected any misspellings |
| Fixes # (issue) | ||
|
|
There was a problem hiding this comment.
[suggestion] Consider giving a different heading and instructions on how to link the issue. This would help contributors understand how to do this process.
| Fixes # (issue) | |
| ## Related Tickets and Documents | |
| <!-- Please use the following format(s) to link your issue(s): | |
| Closes # issue number (e.g, 123) | |
| Relates to # issue number (e.g, 123) | |
| --> |
|
@CBID2 I'll effect these suggestions immediately. Also, thank you for the tip. |
|
@CBID2 I've effected the suggested changes in my PR. |
|
Did you use any template to create this template? |
Yes, I did. |
|
Let's not use a template here. Chances are, it's too long and some of it is not relevant for us |
What do you recommend as an alternative @ykdojo? |
|
It'll be better if we make it from scratch and expand from there. |
|
So a major issue with this current template is the length ? |
|
Yes that is a major thing with it |
|
Okay. I'll redraft it to suit the current stage of the project. Thank you for your feedback. |
|
Hi @ykdojo, I have made corrections to the PR as requested. Please review. |
|
I'm still not sure how this would add value to this project. It includes a mention of a style guide, for example, which we don't have. |
|
Okay noted. I'll make the change. Are there any other areas in this PR you feel should be changed ? |
|
It should be built from scratch without using a template. |
|
No activity here in two weeks. I'll close it if @BlackBond06 has no updates. |
This PR adds a template for creating new pull requests, resolving issue #7.
The following changes were made in this PR: