Browse Source

update issue template

Vicente Penades 2 years ago
parent
commit
25ed537ea0
1 changed files with 17 additions and 26 deletions
  1. 17 26
      .github/ISSUE_TEMPLATE/bug_report.md

+ 17 - 26
.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,38 +1,29 @@
 ---
 ---
 name: Bug report
 name: Bug report
 about: Create a report to help us improve
 about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
+title: "[BUG]"
+labels: bug
+assignees: vpenades
 
 
 ---
 ---
 
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+**Before submitting a bug**
 
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+It is fairly common that loading issues are produced by malformed glTF files, so YOU MUST check the model you're trying to load with glTF Validator before submitting a bug report.
 
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+    https://github.khronos.org/glTF-Validator
 
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+- If glTF Validator reports the model has errors, then you must report the problem to the owner of the exporter, _not here_.
+- If glTF Validator reports no errors, then you can proceed to report the issue here.
 
 
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+I also recomend to preview the model using  https://sandbox.babylonjs.com  to ensure the model looks correct. Some tools like Windows viewer or Blender Importer have issues with some models and might mislead into thinking the model is wrong.
 
 
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+If the issue is complex, or depends on loading or processing a specific model, provide a demo and the models required, otherwise it will take a lot longer to fix.
 
 
-**Additional context**
-Add any other context about the problem here.
+**please complete the following information:**
+ - OS: [e.g. iOS]
+ - SharpGLTF Version [e.g. Alpha-025, or From Source]