Replace ISSUE_TEMPLATE with Bug-Report form #36
Conversation
| attributes: | ||
| label: Contact Details | ||
| description: How can we get in touch with you if we need more info? | ||
| placeholder: ex. email@example.com |
There was a problem hiding this comment.
Do we need PII/email here? Can we just use GitHub aliases?
| attributes: | ||
| label: What happened? | ||
| placeholder: Tell us what you see! | ||
| value: "A bug happened!" |
There was a problem hiding this comment.
Since we're setting placeholder we can probably drop value.
There was a problem hiding this comment.
This is all mostly an adaptation of the form from https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms. I agree the placeholder and value seem redundant, I'm tempted to keep it for the moment just to see what it looks like. I wish there was a "preview" option somewhere.
There was a problem hiding this comment.
Actually, nm. Looking at screenshot in the example it definitely seems redundant so I'll get rid of value.
| attributes: | ||
| label: What did you expect to happen? | ||
| placeholder: Tell us what you wanted! | ||
| value: "No bug" |
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) |
There was a problem hiding this comment.
Do we have a real COC we can link to?
mmlb
force-pushed
the
issue-template-2-bug-report
branch
from
9b14dc7
to
73bd247
Compare
| attributes: | ||
| label: Contact Details | ||
| description: How can we get in touch with you if we need more info? | ||
| placeholder: ex. email@example.com |
| attributes: | ||
| label: What happened? | ||
| placeholder: Tell us what you see! | ||
| value: "A bug happened!" |
There was a problem hiding this comment.
This is all mostly an adaptation of the form from https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms. I agree the placeholder and value seem redundant, I'm tempted to keep it for the moment just to see what it looks like. I wish there was a "preview" option somewhere.
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) |
| attributes: | ||
| label: What happened? | ||
| placeholder: Tell us what you see! | ||
| value: "A bug happened!" |
There was a problem hiding this comment.
Actually, nm. Looking at screenshot in the example it definitely seems redundant so I'll get rid of value.
| attributes: | ||
| label: What did you expect to happen? | ||
| placeholder: Tell us what you wanted! | ||
| value: "No bug" |
|
LGTM |
| id: terms | ||
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](./CODE_OF_CONDUCT.md) |
There was a problem hiding this comment.
Can you absolute link to the COC in tinkerbell/org? I think this relative link won't work for other repos that get this template. (You might need to merge tinkerbell/org#6 first)
mmlb
force-pushed
the
issue-template-2-bug-report
branch
from
73bd247
to
a039de4
Compare
|
LGTM for real |
|
apparently GH doesn't think much of your opinion ;). Need to get you write access to the repos first. |
Signed-off-by: Manuel Mendez <mmendez@equinix.com>
mmlb
force-pushed
the
issue-template-2-bug-report
branch
from
a039de4
to
8a5e221
Compare
|
Oops I just noticed that I used the wrong repo for the CoC link, fixed now. |
|
@micahhausler want to review one more time? |
## Description Add ISSUE_TEMPLATE/config.yaml ## Why is this needed When #36 was merged the old markdown based issue template was removed but github doesn't use the Bug Report template. Maybe because the config.yaml is missing? Lets find out.
## Description Reverts #36 which dropped ISSUE_TEMPLATE.md in favor of the fancy new issue forms. ## Why is this needed GitHub isn't showing the fancy web form and I don't really have the time to debug it at the moment.'
Description
Replace ISSUE_TEMPLATE.md with Bug-Report.yml form based template.
Why is this needed
PR #34 added a form based issue template which causes extra friction to use the old template. By adding this in we should now have 2 options. I think this form is also nicer to use than the markdown template version.