🔧 config: add issue template config and bug report template#488
🔧 config: add issue template config and bug report template#488kenibrewer wants to merge 1 commit intomasterfrom
Conversation
✅ Deploy Preview for nextflow-training ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
vdauwera
left a comment
vdauwera
left a comment
There was a problem hiding this comment.
I love the idea of an issue template. I'm wondering however if this is maybe a little over-engineered, ie separating problem description / code / log output into separate fields might be a bit too rigid. If someone tried several different forms of the code, how/where would they put that? I would tend to favor having one big area for people to describe the problem, and maybe have the placeholder suggest the content/structure we need in order to troubleshoot (ie instructions to include any relevant code and log output).
Also feels like this is missing requesting the specific page URL with the instructions they were following when things went wrong.
| attributes: | ||
| label: Training materials version | ||
| description: What's the git commit hash of the training materials you are using? | ||
| placeholder: ex. email@example.com |
There was a problem hiding this comment.
this seems like the wrong kind of placeholder?
| id: whats-wrong | ||
| attributes: | ||
| label: What's wrong? | ||
| description: What's the problem in the training materials? |
There was a problem hiding this comment.
This seems a bit redundant with the label, maybe state the purpose, ie are we looking for a high level summary here?
|
Revisiting this and wondering if we would be better off pointing people to the forum for all questions, and opening issues ourselves if we determine there's something actually wrong in the code. Thoughts? |
|
Old PR, but I think I'm sort of halfway inbetween:
|
|
Honestly we might just not need a template. We haven't yet received an issue where I've thought "gee you know what I wish this person had been provided a template." |
|
I wouldn't want us to have one just to have one and then it just gets in the way, you know? |
|
Yeah that's kind of what I was thinking 👍🏻 Then we just want the thing to show a link to the forum then, and allow a blank issue. |
|
Yeah that sounds good |
4 participants
This adds an issue template chooser config (see docs along with a bug report issue template.
Together these will encourage folks learning Nextflow to get help in the correct location and ensure we have the info needed for looking into real bugs.
Might be worth adding a new content and/or improvement issue template as part of a separate PR. In the meantime, this config is set to allow blank issues that don't aren't one of the defined issue types (bug-report).