-
Notifications
You must be signed in to change notification settings - Fork 10
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
Created pull request template #225
Conversation
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.
By wrapping lines in <!-- this is an HTML comment --->
they become invisible when creating the PR, even though they have not been removed from the text.
It might be nice to underline that the user making the PR should not interact with the checklist whatsoever, but that it's a reviewer-only feature?
Hmm... actually, the checklist part shouldn't really be in the PR template, but rather it should be a template for the review response (like this one 😉) - also the "Comments" section. But unfortunately, I don't think GitHub supports those kind of templates :|
Yes, initally I wanted a template for the reviewer, but github does not support that as far as I can see. I think this should be an OK help for both reviewer and developer like this, and I think it is better to have this here, than having a separate checklist somewhere else that both reviewer and requester might easily forget. |
Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>
Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>
Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>
Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>
Co-authored-by: Casper Welzel Andersen <43357585+CasperWA@users.noreply.github.com>
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.
Looks fine to me.
There might still be a bit of confusion on my end about why the person opening a PR needs to fill out the checklist (as it's written now), since this should be the reviewer's task, but it's minor.
As a note, you can combine the suggested changes you want to implement from a review and apply/commit them as a batch (all in one) :) |
I kind of agree, this way there is a bit more pressure on the person opening the PR to do it well. Let us try this and see how it works. |
Created a pull request template in the .github folder.
This is intended to be used by the person creating the pull request prior to asking for review and as a help for the reviewer.
It addresses issue 190, which asks for a checklist for the reviewer. This pull request makes #191 redundant.