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

Update issue templates #64983

Merged
merged 1 commit into from Jul 22, 2019
Merged

Update issue templates #64983

merged 1 commit into from Jul 22, 2019

Conversation

zimbatm
Copy link
Member

@zimbatm zimbatm commented Jul 17, 2019

Use the new issue template format and add a "packaging request" template.

The best thing is that labels are pre-applied so they are then easily queryable.

@FRidh
Copy link
Member

FRidh commented Jul 17, 2019

I like to have a couple templates. Important is, though, that there is a general one in case others don't apply, and that it is obvious which one that is and that it is OK to take that one when not sure. I think the general issue should be the default one.

Suggested templates:

  • General issue
  • Bug
  • Security (of course with the mention of https://nixos.org/nixos/security.html)
  • Question (with reference to a page where we list all the places one can request support)
  • Packaging request

@zimbatm
Copy link
Member Author

zimbatm commented Jul 17, 2019

In that case I need to make some more tests. The UI only has 3 entries with pre-defined names: https://github.com/NixOS/nixpkgs/issues/templates/edit
Maybe the filenames matter, maybe not so I need to test this.

@FRidh
Copy link
Member

FRidh commented Jul 17, 2019

Note the motivation for these is because its not something ofborg can handle (unless we add some more advanced NLP to it).

@zimbatm
Copy link
Member Author

zimbatm commented Jul 17, 2019

💥 this is a nice opportunity to add an attrset path selector to the issue template. This would allow ofborg to map an issue to a maintainer for us.

@worldofpeace worldofpeace self-requested a review July 17, 2019 14:06
@zimbatm
Copy link
Member Author

zimbatm commented Jul 18, 2019

After doing a bit of experimentation on my own repo, there is a limit of 3 templates available. + a generic one in small.

image

@gloaming
Copy link
Contributor

Cool! How about "regular" -> "miscellaneous"

Also, upgrade requests seem to be reasonably common. Should they be a separate template, or go under "package requests"?

@zimbatm
Copy link
Member Author

zimbatm commented Jul 18, 2019

We can only have 3 templates so we have to choose carefully. The "open a regular issue" text is not something we control.

@zimbatm
Copy link
Member Author

zimbatm commented Jul 19, 2019

The "Open a regular issues." link uses the old .github/ISSUE_TEMPLATE.md file as a template.

@zimbatm
Copy link
Member Author

zimbatm commented Jul 19, 2019

I'm going to make another pass at the templates to add a front-matter for the structured data

Create new categories for the issues:

* Bug report
* Packaging request
* Security

Add metadata information to the issues so that we may match issues to
maintainers using a bot in the future.

The old `.github/ISSUE_TEMPLATE.md` is being used by the "Open a regular
issue." link.
@zimbatm
Copy link
Member Author

zimbatm commented Jul 19, 2019

Okay this is ready for review.

You can play with the new issue templates over here to see how it will look like: https://github.com/zimbatm/nixpkgs/issues/new/choose

@zimbatm
Copy link
Member Author

zimbatm commented Jul 19, 2019

TODO from @ghuntley: add a untriaged label

@FRidh
Copy link
Member

FRidh commented Jul 20, 2019

Not applicable for these files, but for the other .github/ ones it may be worth it to put them all in one repo:
https://help.github.com/en/articles/creating-a-default-community-health-file-for-your-organization

@zimbatm
Copy link
Member Author

zimbatm commented Jul 20, 2019

@ghuntley showed us a repo with more than 3 templates during the office hours. So maybe we can add many more.

@grahamc
Copy link
Member

grahamc commented Jul 20, 2019

I would be interested in an issue template (and label) for grahamc/r13y.com#3

The idea being I could have a link to a search page, like "autogen-5.18.12. is unreproducible label:reproducibility"

@zimbatm
Copy link
Member Author

zimbatm commented Jul 22, 2019

I'll merge this for now to expose the changes to a wider public so we can iterate on the templates.

@zimbatm zimbatm merged commit 5cece63 into master Jul 22, 2019
@zimbatm zimbatm deleted the new-issue-template branch July 22, 2019 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants