Skip to content
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

PULL_REQUEST_TEMPLATE.md: neon sha checkbox note #39703

Merged
merged 5 commits into from
Oct 18, 2017
Merged

PULL_REQUEST_TEMPLATE.md: neon sha checkbox note #39703

merged 5 commits into from
Oct 18, 2017

Conversation

vitorgalvao
Copy link
Member

Next time I’ll change the checkbox to TICKING THIS CHECKBOX KILLS KITTENS.

I bet people will still click it without reading the instructions.

@vitorgalvao vitorgalvao added the documentation Issue regarding documentation. label Oct 16, 2017
@reitermarkus
Copy link
Member

This really has no end, has it?

@vitorgalvao
Copy link
Member Author

This really has no end, has it?

I’m afraid not.

The initial PR had the bold message as an h3 instead. If this one doesn’t work, I’ll change it to that instead. After that, I’m not sure what to do anymore.

@vitorgalvao
Copy link
Member Author

If we get to a point where the conclusion is that it’s impossible to make an acceptable checkbox, maybe we should just remove it. Then when someone makes a PR that require confirmation, we Request Changes with a snippet linking to the instructions.

@vitorgalvao vitorgalvao mentioned this pull request Oct 16, 2017
10 tasks
@commitay
Copy link
Contributor

If we get to a point where the conclusion is that it’s impossible to make an acceptable checkbox, maybe we should just remove it.

I'm in favour of removing it now.

@vitorgalvao
Copy link
Member Author

vitorgalvao commented Oct 16, 2017

I'm in favour of removing it now.

What’s your say on that, @reitermarkus?

Also, so I get an idea, how stressful is that checkbox for you both? I’ll say that to me the answer is very. It gets me genuinely rilled up inside when it’s misused (ticked when it should be but no confirmation provided; ticked when it shouldn’t; not ticked when it should) in a way that even surprises myself. I have no such reaction to the other checkboxes. I’m asking to understand if it’s just me.

@commitay
Copy link
Contributor

It gets me genuinely rilled up inside when it’s misused (ticked when it should be but no confirmation provided; ticked when it shouldn’t; not ticked when it should) in a way that even surprises myself.

Same.

@reitermarkus
Copy link
Member

I'm not in favour of not removing it. 😜

@vitorgalvao
Copy link
Member Author

Removed. Just need to remember to fix the commit message when merging.

@commitay
Copy link
Contributor

commitay commented Oct 17, 2017

To do after merging:

@miccal
Copy link
Member

miccal commented Oct 17, 2017

I am in favour of leaving it in and taking a leaf out of @MikeMcQuaid's philosophy of just immediately closing the PR with a blurb about not reading the instructions, as they do in the brew and homebrew-core repos.

@commitay
Copy link
Contributor

I am in favour of leaving it in and taking a leaf out of @MikeMcQuaid's philosophy of just immediately closing the PR with a blurb about not reading the instructions, as they do in the brew and homebrew-core repos.

This works for them but not as well for us. A sha256 change means that the Cask is broken.

If we close the PR the Cask stays broken until another user opens a PR (or more likely, an issue) or a maintainer fixes it themselves.

@miccal
Copy link
Member

miccal commented Oct 17, 2017

I understand that, but the Cask will have to be fixed anyway if the sha256 change has not been properly verified, and closing the PR's and creating a new one that does it properly will hopefully get the point across.

@commitay
Copy link
Contributor

#39703 (comment)
Then when someone makes a PR that require confirmation, we Request Changes with a snippet linking to the instructions.


closing the PR's and creating a new one that does it properly will hopefully get the point across.

Closing a PR for another PR assumes that the contributor will actually look at it?

@vitorgalvao
Copy link
Member Author

In sum, I agree with @commitay.

philosophy of just immediately closing the PR with a blurb about not reading the instructions

I do that ruthlessly, but for issues. Then, if the error in the issue is enough clue of the problem, I go and fix it. I then go back to the original issue and link back to the new PR. This both avoids users complaining about the issue being closed and shows how easy it is to fix, as I usually can do it before they even have time to reply. My snippet for that is:

If you ignore this guide, your issue may be closed without review.

Also note from that document:

If the maintainer was wrong in closing your issue, please do reply stating why! Closing an issue does not mean the conversation is over. If the guides themselves were unclear, help us improve them! Open first an issue or pull request stating what you found confusing and only then your other issue.

But for PRs that’s harder to justify, and I’m not sure they do that in HB. Let’s look at which one of those says.

  • If we auto-close on an issue with a wrongly filled template: “Please don’t be lazy. We worked hard on those guides and by not following them you’re saving yourself time and making us spend it”.
  • If we auto-close on a PR: “You spent time on this but we’re not going to spend some ourselves explaining what’s missing”.

I have no quarrel with the first one, but I do with the second. In the first one the user is spitting in our face (yes, exaggeration) while on the second we’re spitting in theirs. I want us to lead by example.

With all that in mind, the sha256 verification process is a boring process that I don’t want to do have to do myself every time. Perhaps because of that the checkbox is a bigger amount of stress. I don’t want to just auto-close and go through the time-consuming process every time — I want users to learn it and do it.

I feel that if we auto-close PRs in those cases users will just think “I don’t care, then”. On the other hand, if we politely Request Changes pointing to instructions, they will follow it. I believe that because that’s what I do when requesting appcasts, and it always works out.

@miccal
Copy link
Member

miccal commented Oct 18, 2017

On the other hand, if we politely Request Changes pointing to instructions, they will follow it.

Fair enough.

@miccal miccal merged commit d41c396 into master Oct 18, 2017
@miccal miccal deleted the pr_sha branch October 18, 2017 05:13
@miccal miccal removed the documentation Issue regarding documentation. label Oct 18, 2017
@Homebrew Homebrew locked and limited conversation to collaborators May 9, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants