From 92b4e2a9321179ac5bb4e71bf16ae8e743ea6214 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Boisselier?= Date: Mon, 16 Oct 2023 11:56:05 +0200 Subject: [PATCH] added issue templates --- .github/FUNDING.yml | 13 +++++++ .github/ISSUE_TEMPLATE/bug_report.yml | 44 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/ISSUE_TEMPLATE/feature_request.yml | 29 ++++++++++++++ 4 files changed, 91 insertions(+) create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..68e2650 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,13 @@ +# These are supported funding model platforms + +github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] +patreon: # Replace with a single Patreon username +open_collective: # Replace with a single Open Collective username +ko_fi: # Replace with a single Ko-fi username +tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel +community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry +liberapay: # Replace with a single Liberapay username +issuehunt: # Replace with a single IssueHunt username +otechie: # Replace with a single Otechie username +lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry +custom: paypal.me/felixboisselier # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..12a9fa8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..8604104 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..d66cfb3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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.