Browse Source

.github/ISSUE_TEMPLATE clean up

Mr.doob 4 years ago
parent
commit
df35985f18

+ 23 - 16
.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,6 +1,6 @@
 ---
 name: Bug report
-about: Create a report to help us improve
+about: Report a reproducible bug or regression.
 title: ''
 labels: ''
 assignees: ''
@@ -8,31 +8,38 @@ assignees: ''
 ---
 
 **Describe the bug**
-A clear and concise description of what the bug is.
+
+A clear and concise description of what the bug is. Before submitting, please remove unnecessary sections.
 
 **To Reproduce**
+
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
-3. Scroll down to '....'
-4. See error
+3. See error
+
+***Code***
+
+```js
+// code goes here
+```
+
+***Live example***
+
+* [jsfiddle-latest-release](https://jsfiddle.net/hyok6tvj/)
+* [jsfiddle-dev](https://jsfiddle.net/c5m1kazu/)
 
 **Expected behavior**
+
 A clear and concise description of what you expected to happen.
 
 **Screenshots**
-If applicable, add screenshots to help explain your problem.
 
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+If applicable, add screenshots to help explain your problem (drag and drop the image).
 
-**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]
+**Platform:**
 
-**Additional context**
-Add any other context about the problem here.
+ - Device: [Desktop, Mobile]
+ - OS: [Windows, MacOS, Linux, Android, iOS]
+ - Browser: [Chrome, Firefox, Safari, Edge]
+ - Three.js version: [dev, r???]

+ 1 - 7
.github/ISSUE_TEMPLATE/config.yml

@@ -2,10 +2,4 @@ blank_issues_enabled: false
 contact_links:
   - name: Community Help and Support
     url: https://discourse.threejs.org/
-    about: Please ask and answer questions here.
-  - name: Stackoverflow
-    url: http://stackoverflow.com/questions/tagged/three.js
-    about: Stackoverflow questions and answers.
-  - name: Writing and formatting Help
-    url: https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax
-    about: Github article on basic writing and formatting on github
+    about: This issue tracker is not for support questions. If you need help, please use the forum.

+ 5 - 1
.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,6 +1,6 @@
 ---
 name: Feature request
-about: Suggest an idea for this project
+about: Suggest an idea for the project.
 title: ''
 labels: ''
 assignees: ''
@@ -8,13 +8,17 @@ assignees: ''
 ---
 
 **Is your feature request related to a problem? Please describe.**
+
 A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 
 **Describe the solution you'd like**
+
 A clear and concise description of what you want to happen.
 
 **Describe alternatives you've considered**
+
 A clear and concise description of any alternative solutions or features you've considered.
 
 **Additional context**
+
 Add any other context or screenshots about the feature request here.