diff --git a/.github/ISSUE_TEMPLATE/1-report-an-issue.yml b/.github/ISSUE_TEMPLATE/1-report-an-issue.yml new file mode 100644 index 0000000..73f20f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-report-an-issue.yml @@ -0,0 +1,82 @@ +name: Report an issue +description: Typically these would be used to create a report to help us improve +labels: [] +body: + - type: checkboxes + id: pre-checks + attributes: + label: My actions before raising this issue + description: Get help fast by ensuring your issue isn't covered elsewhere + options: + - label: Searched [current & past issues](.?q=is%3Aissue%20) + required: true + - type: dropdown + id: sponsors + attributes: + label: Are you a GitHub Sponsor (Yes/No?) + description: Sponsorship makes a real difference in creating time for focussing on issues + options: + - "Yes" + - "No" + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Behaviour + description: Tell us what should be happening. + validations: + required: true + - type: textarea + id: current + attributes: + label: Current Behaviour + description: Tell us what is happening instead of the expected behavior. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: What are the steps to reproduce? + description: Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. + validations: + required: true + - type: textarea + id: workaround + attributes: + label: List Possible Solutions and Workarounds + description: Suggest a fix/reason for the bug, or implementation ideas, or workarounds which could avoid making changes. + validations: + required: true + - type: textarea + id: recommend + attributes: + label: Which Solution Do You Recommend? + description: Of the suggested solutions which would you try first? + validations: + required: true + - type: textarea + id: additional + attributes: + label: Context + description: Any additional context such as how this is affecting you or could affect other users. + validations: + required: true + - type: textarea + attributes: + label: Operating System and version + description: "Operating System and version (e.g. Linux, Windows, MacOS)" + validations: + required: true + - type: textarea + attributes: + label: K3sup Version + description: "Full output from: `k3sup version`" + validations: + required: true + - type: input + attributes: + label: Example code + description: "link to GitHub repo or gist to reproduce problem" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/2-request-a-feature.yml b/.github/ISSUE_TEMPLATE/2-request-a-feature.yml new file mode 100644 index 0000000..8728bba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-request-a-feature.yml @@ -0,0 +1,32 @@ +name: Request a feature +description: Request a new feature or change in this project +labels: [] +body: + - type: textarea + id: what + attributes: + label: What do you want? + description: Focus on the feature, not the technical approach or solution. + validations: + required: true + - type: textarea + id: why + attributes: + label: Why do you want this? + description: Make a case for why your request should be considered. For instance, are you a GitHub Sponsor? + validations: + required: true + - type: textarea + id: approach + attributes: + label: Recommended approach + description: If you are aware of one, share your preferred solution here + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional context + description: Share any other context you feel is relevant or adds to your case. + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..ec4bb38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/report-an-issue.md b/.github/ISSUE_TEMPLATE/report-an-issue.md deleted file mode 100644 index 1f33704..0000000 --- a/.github/ISSUE_TEMPLATE/report-an-issue.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Report an issue -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Expected behaviour** - -What did you expect to happen? - -**Current behaviour** - -What happened? - -**To Reproduce** - -Include full unabridged instructions that anyone can use to reproduce the problem - - -**Screenshots / console output** - -Add a screenshot or console output - -**Versions:** - - OS: - - K3sup Version: - -**Additional context** - -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/request-a-feature.md b/.github/ISSUE_TEMPLATE/request-a-feature.md deleted file mode 100644 index c22c420..0000000 --- a/.github/ISSUE_TEMPLATE/request-a-feature.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Request a feature -about: Request a new feature or change in this project -title: '' -labels: '' -assignees: '' - ---- - -**What do you want?** - -Focus on the feature, not the technical approach or solution. - -**Why do you want this?** - -Make a case for why your request should be considered. For instance, are you a GitHub Sponsor? - -**Recommended solution** - -If you are aware of one, share your preferred solution here - -**Additional context** - -Share any other context you feel is relevant or adds to your case.