From 982ddf9d9f7b6a2aabbce2a7dabec5439c40f3ab Mon Sep 17 00:00:00 2001 From: ydeltastar Date: Sun, 12 Jan 2025 14:20:08 -0300 Subject: [PATCH] Add github issue templates and configurations --- .github/ISSUE_TEMPLATE/bug_report.yml | 54 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_proposal.yml | 38 +++++++++++++++ 3 files changed, 93 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..8737669 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,54 @@ +name: Bug report +description: Create a bug report to help us improve +labels: + - bug +body: + - type: markdown + attributes: + value: | + - Write a descriptive title above. + - Open one issue for one bug. If you notice several bugs and want to report them, make sure to create one new issue for each of them. + - Search open and closed 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.3.stable.official [77dcf97d8] + validations: + required: true + + - type: input + attributes: + label: Plugin version + description: | + - Specify the plugin version. + - You can find the version in Project > Project Settings > Plugins. + placeholder: v0.3 + validations: + required: true + + - type: textarea + attributes: + label: Describe the issue + 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. + - Use code blocks tags with ```gdscript to add GDScript syntax highlighting. + 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 minimal Godot project which reproduces the issue, with no unnecessary files included. + - Be sure to not include the .godot folder in the archive (but keep project.godot). + - Drag and drop a ZIP archive to upload it (10Mb limit). + - Having an MRP is very important for contributors to be able to reproduce the bug in the same way that you are experiencing it. + validations: + required: true 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/feature_proposal.yml b/.github/ISSUE_TEMPLATE/feature_proposal.yml new file mode 100644 index 0000000..042b981 --- /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 +labels: + - enhancement +body: + - type: markdown + attributes: + value: | + - Write a descriptive title above. + - Search open and closed 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 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