Skip to content
This repository has been archived by the owner on Nov 17, 2022. It is now read-only.

Improve this repository issue template #1898

Open
1 of 6 tasks
funder7 opened this issue Jul 16, 2020 · 2 comments
Open
1 of 6 tasks

Improve this repository issue template #1898

funder7 opened this issue Jul 16, 2020 · 2 comments

Comments

@funder7
Copy link

funder7 commented Jul 16, 2020

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
  • 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)

@NathanaelA
Copy link
Contributor

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!

@funder7
Copy link
Author

funder7 commented Jul 16, 2020

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants