summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2022-10-16 01:37:57 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2022-11-17 21:46:41 +0100
commite032152494646da7933fbef13d2914c67b09ce9a (patch)
tree70a801f9afcec8d67bcbbef6ad35db603eaaedab /CONTRIBUTING.md
parent7d9923b2e0b970602c3c6c17b94fae5badf60764 (diff)
downloadredot-engine-e032152494646da7933fbef13d2914c67b09ce9a.tar.gz
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.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md4
1 files changed, 3 insertions, 1 deletions
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.