docs-v7 icon indicating copy to clipboard operation
docs-v7 copied to clipboard

Improve this repository issue template

Open funder7 opened this issue 4 years ago • 2 comments

Make sure to check the existing issues in this repository

Please, tell us what's the problem?

[ ] A typo [ ] Wrong documentation [ ] Improvement of existing article [ ] Missing documentation [ ] New article needed [x] This template checkboxes

  • [ ] Wrong documentation
  • [ ] A typo
  • [ ] Improvement of existing article
  • [ ] Missing documentation
  • [ ] New article needed
  • [x] Are not rendered without the leading "-" (list)

Please, tell us more details

By opening the last issue (#1897), I noticed that the todo checkboxes were not rendered, adding the minus sign before each entry will make the checkboxes render correctly. Recently github introduced some updates, maybe this is not required with older versions?

Nb: check how the issue is rendered in the list: immagine immagine A numeric indicator is reporting how many checkboxes are flagged (probably the purpose of them is to track TODO progress)

funder7 avatar Jul 16 '20 18:07 funder7

Normally as long as you put in a [x] in the checkbox; this tells us at a glance on the template if you have filled out the required info, without using github checkboxes... I think the reason why the template is NOT using the - [ ] is because we don't want the checkboxes on the issues creating the 1 of 6 when their is no actual todo from our side. However, I'll bring this up with the rest of the team to see if they agree. But thank you for your suggestions and keen eye!

NathanaelA avatar Jul 16 '20 19:07 NathanaelA

No problem! I tought it was a problem due to recent github updates :-) Check this, I've found it while reading about issue templates: immagine

Anyway I think that the "n of X" label cannot be avoided for now...maybe they will update that too!
Edit: I've asked in the support forum

Cheers

funder7 avatar Jul 16 '20 20:07 funder7