Skip to content

Conversation

papandreou
Copy link
Contributor

So that the checkboxes are rendered correctly.

Prerequisites checklist

  • I have read the contributing guidelines.
  • The team has reached consensus on the changes proposed in this pull request. If not, I understand that the evaluation process will begin with this pull request and won't be merged until the team has reached consensus.

What is the purpose of this pull request? (put an "X" next to an item)

  • Documentation update
  • Bug fix (template)
  • New rule (template)
  • Changes an existing rule (template)
  • Add autofixing to a rule
  • Add a CLI option
  • Add something to the core
  • Other, please explain:

What changes did you make? (Give an overview)

When opening another PR I noticed that a bunch of lines starting with [ ] that came from the github PR template weren't properly rendered as a list of checkboxes. I changed the templates so they do 🤗

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Feb 22, 2020
So that the checkboxes are rendered correctly.
@papandreou papandreou force-pushed the fix/checkboxesInIssueTemplates branch from a83cb0e to 57f550c Compare February 22, 2020 16:37
@kaicataldo
Copy link
Member

Thanks for contributing. The current template is that way by design, because if they were actual checkboxes the PR list view would show 1/x checkboxes checked. It would be nice if we had some way of creating radio buttons that only allowed one to be selected, but markdown unfortunately doesn’t support that.

@papandreou
Copy link
Contributor Author

Haha, okay, that's fair enough. It seems like contributors are confused enough that they only follow the instructions half of the time, though. I went through the first 4 pages of PRs and counted:

  • 47 left the list as-is, added one X in one of the boxes 👌
  • 39 edited the list down to just one item with [X] in front of it
  • 5 left the list as-is, added X in two of the boxes
  • 5 edited the markdown so it's a list of checkboxes, then added one X (this includes my PRs)
  • 1 edited the list down to one item without [X]
  • 1 edited the list down to two items with [X] in front
  • 1 left the list as-is without adding any X at all 🤔
  • 1 removed the list altogether 🙈

I guess it doesn't really matter, actually. But I'll maintain that it does look like a mistake in the templates when you know the gh flavored markdown syntax for a checkbox 😼

@kaicataldo
Copy link
Member

Agreed. I think there are two issues at play:

  1. The one you mentioned, where it can easily seem like a typo if you’re used to writing lists in markdown.
  2. We as a team haven’t been very good at enforcing these rules.

It definitely would be nice to figure out a better system. In my personal experience, templates in general don’t seem to be very effective in issues or PRs (though they’re better than nothing!).

@kaicataldo
Copy link
Member

If you have a suggestion for an alternative system, I’d love to hear your idea!

@nzakas
Copy link
Member

nzakas commented Feb 25, 2020

Agree with @kaicataldo that the template format is intentional. I’d suggest opening an issue if you have other ideas about how to improve the template.

@nzakas nzakas closed this Feb 25, 2020
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Aug 25, 2020
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Aug 25, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion triage An ESLint team member will look at this issue soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants