chore: add issue templates

[vitorfloriano]

This PR adds Issue Templates to the repository.

We're adding templates (technically, they are forms) for bug report, feature request and issue tracking.

We're also allowing blank issues as an escape hatch, just in case.

For a preview of the templates, see: https://github.com/vitorfloriano/node-readiness-controller/tree/chore-add-github-issue-templates/.github/ISSUE_TEMPLATE

Follow-up to #227 (comment)

[k8s-ci-robot]

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

[netlify]

✅ Deploy Preview for node-readiness-controller canceled.

Name	Link
🔨 Latest commit	c4f71e7
🔍 Latest deploy log	https://app.netlify.com/projects/node-readiness-controller/deploys/6a0bd77865a22f00081afc93

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: vitorfloriano
Once this PR has been reviewed and has the lgtm label, please assign ajaysundark for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[vitorfloriano]

/cc @Priyankasaggu11929

I had copilot make the initial draft of the templates for me. I still need to refine them to remove any nonsense.

Just a couple of things:

1. Should we go for markdown (templates) for more flexibility or yaml (forms) for more structure? I've noticed projects in the org use both. See: https://github.com/search?q=%28org%3Akubernetes+OR+org%3Akubernetes-sigs%29+path%3AISSUE_TEMPLATE+&type=code&p=2
2. Should we enforce the templates/forms or should we still allow blank issues?
3. I added links to direct users to Discussions, Slack and Security in the Issue creation modal. Should we keep those?

/hold

[Priyankasaggu11929]

Should we go for markdown (templates) for more flexibility or yaml (forms) for more structure? I've noticed projects in the org use both. See: https://github.com/search?q=%28org%3Akubernetes+OR+org%3Akubernetes-sigs%29+path%3AISSUE_TEMPLATE+&type=code&p=2

I usually prefer Markdown templates (well, because they're simple) but looking at recent influx of gh issues contributions, I feel the pointed sections in yaml will encourage people to fill in proper information.

can we please add a line saying something like (not as it is, but you get the point) -

please describe the issue in a simple manner in your own language (and not with AI generated blurb)?

Should we enforce the templates/forms or should we still allow blank issues?

allow blank issues as well.

---

3. I added links to direct users to Discussions, Slack and Security in the Issue creation modal. Should we keep those?

I am not aware of it ^. How does this work? Could you please share an example?

Thank you!

[sahitya-chandra]

Small suggestion on bug_report.yml: for the logs textarea, would you consider render: shell (or render: console) instead of render: text?

GitHub will render it as a syntax-highlighted code block, which keeps long controller log dumps from blowing out the issue layout.

[vitorfloriano]

I am not aware of it ^. How does this work? Could you please share an example?

I merged this branch in my fork to preview the changes, so you can head over there and create a new issue. The Create a new issue modal will show links for Slack and Discussions:

https://github.com/vitorfloriano/node-readiness-controller/issues

The "Report a vulnerability" is duplicated because I wasn't aware that it was already there by default (though I'm not sure if that's only in my fork's config). I will remove that.

[Priyankasaggu11929]

I merged this branch in my fork to preview the changes, so you can head over there and create a new issue. The Create a new issue modal will show links for Slack and Discussions:

Nice! TIL. Thank you and yes, let's add it.

The "Report a vulnerability" is duplicated because I wasn't aware that it was already there by default (though I'm not sure if that's only in my fork's config). I will remove that.

👍

[vitorfloriano]

GitHub will render it as a syntax-highlighted code block, which keeps long controller log dumps from blowing out the issue layout.

@sahitya-chandra I tested render: shell, render: console and render: text and it seems that the log dumps will always be the same size, with minimal syntax highlighting.

Perhaps we should make a textarea with a <details> element in it. See the three Log sections in the issue I created to test this: vitorfloriano#7 (The last one is collapsible because I added a details element to the text area)

Or we could make it an upload form and have users send their logs in .txt.

Anyway, this is very bikesheddable.