Skip to content

Commit 793db20

Browse files
authored
chore: add bug_report.yml from godot base project (#202)
1 parent 652839a commit 793db20

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Bug report
2+
description: Report a bug in GodotJS
3+
body:
4+
5+
- type: markdown
6+
attributes:
7+
value: |
8+
When reporting bugs, please follow the guidelines in this template. This helps identify the problem precisely and thus enables contributors to fix it faster.
9+
- Write a descriptive issue title above.
10+
- The golden rule is to **always 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.
11+
- Search [open](https://github.com/godotengine/godot/issues) and [closed](https://github.com/godotengine/godot/issues?q=is%3Aissue+is%3Aclosed) issues to ensure it has not already been reported. If you don't find a relevant match or if you're unsure, don't hesitate to **open a new issue**. The bugsquad will handle it from there if it's a duplicate.
12+
- Verify that you are using a [supported Godot version](https://github.com/Geequlim/ECMAScript/releases). Please always check if your issue is reproducible in the latest version – it may already have been fixed!
13+
14+
- type: input
15+
attributes:
16+
label: Version
17+
description: >
18+
Specify the Godot version, including the Git commit hash if using a development or non-official build. The exact Godot version (including the commit hash) can be copied by clicking the version shown in the editor (bottom bar) or in the project manager (top bar).
19+
placeholder: 4.1-v0.0.17-alpha-20231003
20+
validations:
21+
required: true
22+
23+
- type: input
24+
attributes:
25+
label: System information
26+
description: |
27+
- Specify the OS version, and when relevant hardware information.
28+
- For issues that are likely OS-specific and/or graphics-related, please specify the CPU model and architecture.
29+
- For graphics-related issues, specify the GPU model, driver version, and the rendering backend (GLES2, GLES3, Vulkan).
30+
- **Bug reports not including the required information may be closed at the maintainers' discretion.** If in doubt, always include all the requested information; it's better to include too much information than not enough information.
31+
- **Starting from Godot 4.1, you can copy this information to your clipboard by using *Help > Copy System Info* at the top of the editor window.**
32+
placeholder: Windows 10 - Godot v4.0.3.stable - Vulkan (Forward+) - dedicated NVIDIA GeForce GTX 970 (nvidia, 510.85.02) - Intel Core i7-10700KF CPU @ 3.80GHz (16 Threads)
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
attributes:
38+
label: Issue description
39+
description: |
40+
Describe your issue briefly. What doesn't work, and how do you expect it to work instead?
41+
You can include images or videos with drag and drop, and format code blocks or logs with <code>\`\`\`</code> tags, on separate lines before and after the text. (Use <code>\`\`\`gdscript</code> to add GDScript syntax highlighting.)
42+
Please do not add code examples or error messages as screenshots, but as text, this helps searching for issues and testing the code. If you are reporting a bug in the editor interface, like the script editor, please provide both a screenshot *and* the text of the code to help with testing.
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
attributes:
48+
label: Steps to reproduce
49+
description: |
50+
List of steps or sample code that reproduces the issue. Having reproducible issues is a prerequisite for contributors to be able to solve them.
51+
If you include a minimal reproduction project below, you can detail how to use it here.
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
attributes:
57+
label: Minimal reproduction project (MRP)
58+
description: |
59+
- A small 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`).
60+
- Having an MRP is very important for contributors to be able to reproduce the bug in the same way that you are experiencing it. When testing a potential fix for the issue, contributors will use the MRP to validate that the fix is working as intended.
61+
- If the reproduction steps are not project dependent (e.g. the bug is visible in a brand new project), you can write "N/A" in the field.
62+
- Drag and drop a ZIP archive to upload it (max 10 MB). **Do not select another field until the project is done uploading.**
63+
validations:
64+
required: true

0 commit comments

Comments
 (0)