added issue templates

This commit is contained in:
Félix Boisselier
2023-10-16 11:56:05 +02:00
parent 2c46bbb650
commit 92b4e2a932
4 changed files with 91 additions and 0 deletions

44
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@@ -0,0 +1,44 @@
name: "\U0001F41B Bug report"
description: Report a bug or problem with this Klippain Shake&Tune module.
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
This issue form is for reporting bugs only!
If you have a feature request, please use [feature_request](/new?template=feature_request.yml) instead.
- type: checkboxes
id: k-shaketune-branch
attributes:
label: K-Shake&Tune module branch
description: By submitting this issue, you confirm using a "public" release of this module, from the main branch. We do not provide support for the dev version from other branches as they are known to be unstable.
options:
- label: I confirm using the main branch
required: true
- type: input
id: k-shaketune-version
attributes:
label: Version
description: Specify the version of K-Shake&Tune used on your printer. You can find this in the update section of Mainsail/Fluidd.
placeholder: ex. v4.0.1-44-g84aba96
validations:
required: true
- type: textarea
id: what-happened
attributes:
label: Describe the bug and expected behavior
description: >-
Provide a clear and concise description of the bug and why it's problematic.
If applicable, suggest a desired solution.
validations:
required: true
- type: textarea
id: additional-info
attributes:
label: Additional information and klippy.log
description: |
If possible, attach a klippy.log to help us diagnose your issue!
You can also provide any additional helpful details.
Please note, you can attach files or screenshots by dragging and dropping them directly in the field.

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Public \#Klippain thread in the Voron Discord
url: https://discord.com/channels/460117602945990666/1096701708643614820
about: Quickest way to get in contact if you just want to have a chat

View File

@@ -0,0 +1,29 @@
name: "\U0001F680 Feature request"
description: Suggest a new feature for K-Shake&Tune.
labels: ["enhancement", "triage"]
body:
- type: markdown
attributes:
value: |
This issue form is for suggesting features or hardware support only!
If you're facing a bug, please use the [bug_report](/new?template=bug_report.yml) instead.
- type: textarea
id: feature-description
attributes:
label: Describe the feature or hardware support you'd like
description: >-
Provide a clear and detailed description of the feature you'd like to see in this Klippain Shake&Tune module.
Also do not hesistate to explain how your suggestion can enhance this module and benefit its users.
placeholder: E.g., "I'd love to see support for this XXX new kind of computation..."
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context or information
description: |
If you have any more information, references, or context about your suggestion, please provide it here.
This can include use-cases, diagrams, documentation, links or any other helpful details.
Please note, you can attach files or screenshots by dragging and dropping them directly in the field.