diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2022-10-16 01:37:57 +0200 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2022-11-17 21:46:41 +0100 |
| commit | e032152494646da7933fbef13d2914c67b09ce9a (patch) | |
| tree | 70a801f9afcec8d67bcbbef6ad35db603eaaedab | |
| parent | 7d9923b2e0b970602c3c6c17b94fae5badf60764 (diff) | |
Emphasize the importance of uploading a minimal reproduction project
The field is now required, but "N/A" can be manually entered if
the reproduction steps are trivial and don't require any project
files to be followed.
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.yml | 7 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 4 |
2 files changed, 8 insertions, 3 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 690e74855f..0b4abac1af 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -52,5 +52,8 @@ body: 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. Be sure to not include the ".godot" folder in the archive. + 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`). + 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. + Drag and drop a ZIP archive to upload it. **Do not select another field until the project is done uploading.** + validations: + required: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a1e8d3a59d..63e6a89e64 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -63,6 +63,8 @@ understand that: - What happens to you may not happen to other users. - We can't take the time to look at your project, understand how it is set up and then figure out why it's failing. +- On the contributors' end, recreating a test project from scratch takes valuable + time that can be saved by uploading a *minimal* project. To speed up our work, **please upload a minimal project** that isolates and reproduces the issue. This is always the **best way for us to fix it**. @@ -74,7 +76,7 @@ if your ZIP file isn't accepted by GitHub because it's too large. We recommend always attaching a minimal reproduction project, even if the issue may seem simple to reproduce manually. -**Note for C# users:** If your issue is not .NET-specific, please upload a +**Note for C# users:** If your issue is *not* .NET-specific, please upload a minimal reproduction project written in GDScript. This will make it easier for contributors to reproduce the issue locally as not everyone has a .NET setup available. |