Merge pull request #31 from fire/reports

Add bug report and proposal templates.
This commit is contained in:
K. S. Ernest (iFire) Lee
2022-12-03 10:07:12 -08:00
committed by GitHub
3 changed files with 114 additions and 0 deletions

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

@@ -0,0 +1,56 @@
name: Bug report
description: Report a bug in Godot
body:
- type: markdown
attributes:
value: |
- Read our [CONTRIBUTING.md guide](https://github.com/godotengine/godot/blob/master/CONTRIBUTING.md#reporting-bugs) on reporting bugs.
- Write a descriptive issue title above.
- Search [open](https://github.com/godotengine/godot-visual-script/issues) and [closed](https://github.com/godotengine/godot-visual-script/issues?q=is%3Aissue+is%3Aclosed) issues to ensure it has not already been reported.
- Verify that you are using a [supported Godot version](https://docs.godotengine.org/en/stable/about/release_policy.html).
- type: input
attributes:
label: Godot version
description: >
Specify the Git commit hash if using a development or non-official build.
If you use a custom build, please test if your issue is reproducible in official builds too.
placeholder: 3.3.stable, 4.0.dev (3041becc6)
validations:
required: true
- type: input
attributes:
label: System information
description: |
Specify the OS version, and when relevant hardware information.
For graphics-related issues, specify the GPU model, driver version, and the rendering backend (GLES2, GLES3, Vulkan).
placeholder: Windows 10, GLES3, Intel HD Graphics 620 (27.20.100.9616)
validations:
required: true
- type: textarea
attributes:
label: Issue description
description: |
Describe your issue briefly. What doesn't work, and how do you expect it to work instead?
You can include images or videos with drag and drop, and format code blocks or logs with <code>```</code> tags.
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: |
List of steps or sample code that reproduces the issue. Having reproducible issues is a prerequisite for contributors to be able to solve them.
If you include a minimal reproduction project below, you can detail how to use it here.
validations:
required: true
- type: textarea
attributes:
label: Minimal reproduction project
description: |
A small Godot project which reproduces the issue. Highly recommended to speed up troubleshooting.
Drag and drop a ZIP archive to upload it.

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

@@ -0,0 +1,6 @@
blank_issues_enabled: false
contact_links:
- name: Godot community channels
url: https://godotengine.org/community
about: Please ask for technical support on one of the other community channels, not here.

View File

@@ -0,0 +1,52 @@
name: Feature implementation proposal
description: Propose a possible solution to solve an engine limitation
body:
- type: markdown
attributes:
value: |
- Write a descriptive proposal title above.
- Search [open](https://github.com/godotengine/godot-visual-script/issues) and [closed](https://github.com/godotengine/godot-visual-script/issues?q=is%3Aissue+is%3Aclosed) proposals to ensure the feature has not already been suggested.
- type: textarea
attributes:
label: Describe the project you are working on
description: This is important to know the *context* in which the feature is being proposed. Features used in real-world projects are more likely to be added.
placeholder: Example - "A 3D space game with heavy use of cut-out animation"
validations:
required: true
- type: textarea
attributes:
label: Describe the problem or limitation you are having in your project
placeholder: Example - "The 3D selection tools are cumbersome to use."
validations:
required: true
- type: textarea
attributes:
label: Describe the feature / enhancement and how it helps to overcome the problem or limitation
placeholder: Example - "Add keyboard shortcuts to select groups of nodes quickly."
validations:
required: true
- type: textarea
attributes:
label: Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams
placeholder: Example - "When the user presses Ctrl + Shift + G, select all nodes that have the group..."
validations:
required: true
- type: textarea
attributes:
label: If this enhancement will not be used often, can it be worked around with a few lines of script?
placeholder: Example - "This can be worked around with an editor plugin, but it is not particularly convenient."
validations:
required: true
- type: textarea
attributes:
label: Is there a reason why this should be core and not an add-on in the asset library?
placeholder: Example - "This is about improving the 3D editor usability out of the box."
validations:
required: true