-
-
Notifications
You must be signed in to change notification settings - Fork 41
Update PULL_REQUEST_TEMPLATE.md #470
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
Conversation
change stuff that isnt actually in tux and clarify stuff
Reviewer's Guide by SourceryThis pull request updates the PULL_REQUEST_TEMPLATE.md file to streamline and clarify the pull request process. The changes focus on simplifying the template, adding more specific instructions, and adjusting the checklist items to better reflect the project's workflow. File-Level Changes
Tips
|
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.
Hey @electron271 - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider encouraging more detailed testing information for significant changes or new features, while keeping it simple for minor updates.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 1 issue found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
|
|
||
| - [ ] Test A | ||
| - [ ] Test B | ||
| Please describe how you tested your code. e.g describe what commands you ran, what arguments, and any config stuff (if applicable) |
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.
suggestion (documentation): Consider providing more structure for test description
While the open-ended format allows flexibility, you might want to include some prompts or examples to ensure comprehensive test descriptions.
| Please describe how you tested your code. e.g describe what commands you ran, what arguments, and any config stuff (if applicable) | |
| ## Testing | |
| Please describe how you tested your code: | |
| - [ ] Commands run: | |
| - [ ] Arguments used: | |
| - [ ] Configuration details: | |
| - [ ] Test cases covered: | |
| - [ ] Edge cases considered: | |
| - [ ] Any additional testing notes: |
make guideline checking less time consuming
Description
change stuff that isnt actually in tux and clarify stuff
Type of Change
Checklist
How Has This Been Tested?
not applicable
Screenshots (if applicable)
Please add screenshots to help explain your changes.
Additional Information
Please add any other information that is important to this PR.
Summary by Sourcery
Revise the pull request template to improve clarity on how to document issue fixes and testing procedures, and update the checklist to reflect current project standards.
Documentation: