From 15464e288c88e634114d26abe0841990bab19125 Mon Sep 17 00:00:00 2001 From: Serhii Snitsaruk Date: Sat, 29 Jun 2024 13:35:01 +0200 Subject: [PATCH] GH: Add issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 64 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 14 +++++ .github/ISSUE_TEMPLATE/feature_proposal.yml | 38 ++++++++++++ 3 files changed, 116 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_proposal.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..3f2a201 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,64 @@ +name: Bug report +description: Report a bug in LimboAI +labels: + - bug +body: + - type: markdown + attributes: + value: | + - Write a descriptive title above. + - Search [open](https://github.com/limbonaut/limboai/issues) and [closed](https://github.com/limbonaut/limboai/issues?q=is%3Aissue+is%3Aclosed) issues to ensure it has not already been reported. + + - type: input + attributes: + label: Godot version + description: | + - Specify the Godot version and hardware information if relevant. + - You can copy the version info by clicking on it in the Godot status bar. + - Alternatively, you can copy the version and hardware info in Godot using the main menu command "Help -> Copy System Info". + placeholder: v4.2.2.limboai+v1.1.0.gha [15073afe3] + validations: + required: true + + - type: input + attributes: + label: LimboAI version + description: | + - Specify the LimboAI version. + - You can copy the version info by clicking on it in the toolbar of the LimboAI editor (top-right corner). + placeholder: v1.1.0 [8fa609e] + validations: + required: true + + - type: dropdown + id: variant + attributes: + label: LimboAI variant + description: Which variant of our plugin are you running? + options: + - GDExtension / AssetLib + - Module (custom editor or template build) + default: 0 + validations: + required: true + + - type: textarea + attributes: + label: Issue description + description: | + - Describe your issue in detail. What doesn't work and how do you expect it to work instead? + - Provide screenshots and/or a console output if it helps to convey the problem. + validations: + required: true + + - type: textarea + attributes: + label: How to reproduce + description: | + - Provide a list of steps or sample code that reproduces the issue. + - You can provide a small Godot project which reproduces the issue, with no unnecessary files included. + - Drag and drop a ZIP archive to upload it (10Mb limit). + - Don't include the `.godot` folder in the archive. + - Redroduction project helps to find the bug more quickly! + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..9dbc47c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false + +contact_links: + - name: Documentation + url: https://limboai.readthedocs.io/en/stable/ + about: Please see our documentation for more information. + + - name: Discussions + url: https://github.com/limbonaut/limboai/discussions + about: Need help? Ask questions in Discussions or on our Discord server. + + - name: Discord Server + url: https://discord.gg/N5MGC95GpP + about: Share your experience or get help on our Discord server. diff --git a/.github/ISSUE_TEMPLATE/feature_proposal.yml b/.github/ISSUE_TEMPLATE/feature_proposal.yml new file mode 100644 index 0000000..2ac8ae8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_proposal.yml @@ -0,0 +1,38 @@ +name: Feature or improvement proposal +description: Propose a new feature to be added or improved in LimboAI +labels: + - enhancement +body: + - type: markdown + attributes: + value: | + - Write a descriptive title above. + - Search [open](https://github.com/limbonaut/limboai/issues) and [closed](https://github.com/limbonaut/limboai/issues?q=is%3Aissue+is%3Aclosed) issues to ensure it has not already been reported. + + - type: textarea + attributes: + label: Problem statement + description: | + - Describe the problem or limitation you're currently facing with the LimboAI plugin. + - If it helps, describe the project you're working on and how it relates to the problem or limitation. + validations: + required: true + + - type: textarea + attributes: + label: Proposed solution + description: | + - Describe your proposed solution and how it helps to overcome the problem or limitation. + - If it helps, show how it will work with code, pseudo-code, mock-ups, and/or diagrams. + - You can include any images or videos with drag'n'drop, and sample code blocks with ``` tags. + validations: + required: true + + - type: textarea + attributes: + label: Alternatives + description: | + - Describe alternative solutions and features you've considered. + - If this enhancement will not be used often, can it be worked around with a few clicks or lines of code? + validations: + required: true