From cd5ea4463ea4767fd17bd92340d387a30d166386 Mon Sep 17 00:00:00 2001 From: Greg <35217125+dreadpon@users.noreply.github.com> Date: Tue, 21 Jun 2022 00:26:44 +0300 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 44 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 31 ++++++++++++++++ 2 files changed, 75 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..a730530 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,44 @@ +--- +name: Bug report +about: Create a bug report to help improve this project +title: "[BUG]" +labels: '' +assignees: dreadpon + +--- + +**Godot version** +*Specify a numerical Godot version you are using. Include Git commit hash if possible.* +Example: +"3.4.2 (45eaa2d), 3.4.4 (419e713), etc." + + +**Plugin version** +*Specify a numerical Spatial Gardener version you are using. Include Git commit hash if possible.* +Example: +"0.1.0 (3283e07), etc." + + +**Platform** +*What platform you were using, when you encountered this bug?* +Example: +"Windows 10, MacOS, etc." + + +**Issue description** +*Describe your issue. What is expected to happen? What actually happened?* +Example: +"I entered Konami code and my PC blue-screened +I expected some cool easter egg instead" + + +**Steps to Reproduce** +*Describe steps for others to reproduce this issue* +Example: +"1. Go to ... +2. Click on ... +3. Observe the ..." + + +**Minimal reproduction project** +*If applicable, please paste a link to minimal reproduction project that shows this issue in action.* diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..9e16bba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,31 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[FEATURE REQUEST]" +labels: '' +assignees: dreadpon + +--- + +**Describe the problem you're trying to solve in your project** +*Give a brief description of what kind of project you're working on and what problem or limitation made you request a feature.* +Example: +"I'm working on a parkour game and I need my trees to collide with the player." + + +**Describe a feature you consider and how it will help you** +*Tell what your feature will do, how you would use it and how often.* +Example: +"Tree collision can be incorporated into existing LOD variants - that way it can even be freed dynamically or simplified. I would update all my tree `Plants` with physics bodies and use them throrought all my levels." + + +**Describe alternatives you've considered** +*A clear and concise description of any alternative solutions or features you've considered.* +Example: +"It's possible to iterate manually on all octree memebers, but tree collision seems like such a basic functionality, that it should be in the core plugin." + + +**Describe how you imagine it would work. With code, pseudo-code, diagram or a drawing** +*Give a breakdown from a technological perspective. Provide examples of similar functionality if possible.* +Example: +"Instead of referencing a mesh, LOD variants should be their own resource - housing both the mesh and a physics body. Whenever an instance is added or removed - update physics bodies as well."