Simplify the PR template, add checkboxes, remove redundant info#3851
Merged
Simplify the PR template, add checkboxes, remove redundant info#3851
Conversation
zivkan
approved these changes
Jan 20, 2021
Member
zivkan
left a comment
There was a problem hiding this comment.
I like it 👍
Only comment is that the checklists will cause the PR view to claim the PRs have completed "5/8 tasks", or something like that. Not a big deal, we'll just need to learn to live with it, and I don't really have any better suggestion.
<-- Delete all but one -->
Tests: Automated tests added
Tests: Test exception
Tests: N/A
Tests: [Automated tests added|Test exception|N/A]
Tests: Automated tests added **OR** Test exception **OR** N/A
I think your template is most likely to have contributors do what we want.
Member
Author
Yeah, I had the same thought. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Bug
Fixes: https://github.com/NuGet/Client.Engineering/issues/432
Regression: No
Fix
Details:
@zivkan suggested using https://github.com/PowerShell/PowerShell/blob/master/.github/PULL_REQUEST_TEMPLATE.md as inspiration.
Simplifying the PR template.
Retain only relevant information and make it easy for the contributor to honor the template (ex. using checkboxes instead of having to replace text.)
Keep it relatively simple (not super thrilled about the length), as large templates are .
Any feedback welcome 👍 I created this PR to start a conversation.
Testing/Validation
Tests Added: No
Reason for not adding tests:
Validation: