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

chore: add issue templates #449

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/1-report-an-issue.yml
Original file line number Diff line number Diff line change
@@ -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
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/2-request-a-feature.yml
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/report-an-issue.md

This file was deleted.

24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/request-a-feature.md

This file was deleted.