Skip to content

Commit e7c57a3

Browse files
committed
Add issue template based on the main Godot repository
1 parent feaba55 commit e7c57a3

File tree

2 files changed

+85
-0
lines changed

2 files changed

+85
-0
lines changed
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Bug report
2+
description: Report a bug in the godot-cpp GDExtension/GDNative integration
3+
body:
4+
5+
- type: markdown
6+
attributes:
7+
value: |
8+
- When reporting bugs, you'll make our life simpler (and the fix will come sooner) if you follow the guidelines in this template.
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-cpp/issues) and [closed](https://github.com/godotengine/godot-cpp/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://docs.godotengine.org/en/stable/about/release_policy.html).
13+
14+
- type: input
15+
attributes:
16+
label: Godot version
17+
description: >
18+
Specify the Git commit hash if using a development or non-official build.
19+
If you use a custom build, please test if your issue is reproducible in official builds too.
20+
placeholder: 3.3.stable, 4.0.dev (3041becc6)
21+
validations:
22+
required: true
23+
24+
- type: input
25+
attributes:
26+
label: godot-cpp version
27+
description: >
28+
Specify the Git commit hash if using a development build.
29+
placeholder: 3.3.stable, 4.0.dev (3041becc6)
30+
validations:
31+
required: true
32+
33+
- type: input
34+
attributes:
35+
label: System information
36+
description: |
37+
- Specify the OS version, and when relevant hardware information.
38+
- For issues that are likely OS-specific and/or graphics-related, please specify the CPU model and architecture.
39+
- **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.
40+
placeholder: Windows 10, Intel Core i5-7200U
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
attributes:
46+
label: Issue description
47+
description: |
48+
Describe your issue briefly. What doesn't work, and how do you expect it to work instead?
49+
You can include images or videos with drag and drop, and format code blocks or logs with <code>```</code> tags.
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
attributes:
55+
label: Steps to reproduce
56+
description: |
57+
List of steps or sample code that reproduces the issue. Having reproducible issues is a prerequisite for contributors to be able to solve them.
58+
If you include a minimal reproduction project below, you can detail how to use it here.
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
attributes:
64+
label: Minimal reproduction project
65+
description: |
66+
- 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`).
67+
- Required, unless the reproduction steps are trivial and don't require any project files to be followed. In this case, write "N/A" in the field.
68+
- Drag and drop a ZIP archive to upload it. **Do not select another field until the project is done uploading.**
69+
- **If you've been asked by a maintainer to upload a minimal reproduction project, you *must* do so within 7 days.** Otherwise, your bug report will be closed as it'll be considered too difficult to diagnose.
70+
validations:
71+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: Godot proposals
5+
url: https://github.com/godotengine/godot-proposals
6+
about: Please submit feature proposals on the Godot proposals repository, not here.
7+
8+
- name: Godot documentation repository
9+
url: https://github.com/godotengine/godot-docs
10+
about: Please report issues with documentation on the Godot documentation repository, not here.
11+
12+
- name: Godot community channels
13+
url: https://godotengine.org/community
14+
about: Please ask for technical support on one of the other community channels, not here.

0 commit comments

Comments
 (0)