Skip to content

/ docs

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

Jump to bottom

Improve this repository issue template #1898

Open
funder7 opened this issue Jul 16, 2020 · 2 comments
Open

Improve this repository issue template #1898

funder7 opened this issue Jul 16, 2020 · 2 comments

Comments

@funder7
Copy link

@funder7 funder7 commented Jul 16, 2020 •
edited by NathanaelA

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
Member

@NathanaelA NathanaelA commented Jul 16, 2020

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 funder7 commented Jul 16, 2020 •
edited

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 join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
@NathanaelA @funder7
You can’t perform that action at this time.