Skip to content

Simplify the PR template, add checkboxes, remove redundant info#3851

Merged
nkolev92 merged 9 commits intodevfrom
dev-nkolev92-simplifyAndImprovePRTemplate
Jan 23, 2021
Merged

Simplify the PR template, add checkboxes, remove redundant info#3851
nkolev92 merged 9 commits intodevfrom
dev-nkolev92-simplifyAndImprovePRTemplate

Conversation

@nkolev92
Copy link
Member

Bug

Fixes: https://github.com/NuGet/Client.Engineering/issues/432
Regression: No

  • Last working version:
  • How are we preventing it in future:

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:

@nkolev92 nkolev92 requested a review from a team as a code owner January 16, 2021 00:28
Copy link
Member

@zivkan zivkan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@nkolev92
Copy link
Member Author

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.

Yeah, I had the same thought.
There's just no way to create a radio box in markdown right now.

@nkolev92 nkolev92 merged commit eda79dd into dev Jan 23, 2021
@nkolev92 nkolev92 deleted the dev-nkolev92-simplifyAndImprovePRTemplate branch January 23, 2021 00:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants