Skip to content

Commit 050821e

Browse files
committed
Simpler CONTRIBUTING suggested by @WestLangley. Fixes mrdoob#2847.
1 parent 9e878ea commit 050821e

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed

CONTRIBUTING.md

+21-17
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,27 @@
11
# The issues section is for bug reports and feature requests only. If you need help, please use [stackoverflow](http://stackoverflow.com/questions/tagged/three.js).
22

3-
## How to report a bug?
43

5-
* Tell us the revision number of three.js you use.
6-
* Try checking your application with the latest `dev` branch version of three.js (often problems are already fixed there). See [migration guide](https://github.com/mrdoob/three.js/wiki/Migration).
7-
* Tell us where did you observe the problem: your browser version, your operating system, your graphics card (for example Chrome 23.0.1271.95, Windows 7, Nvidia Quadro 2000M)
8-
* If you can, try to check your problem on multiple browsers / multiple computers (if you are on Windows, especially helpful is to [compare ANGLE and OpenGL renderers](https://github.com/mrdoob/three.js/wiki/How-to-use-OpenGL-or-ANGLE-rendering-on-Windows))
9-
* Describe the problem in details (what you get instead of what's expected). Saying "it doesn't work" doesn't help much.
10-
* Create a small testcase (big chance is when you do this, you'll find the answer yourself).
11-
* If small testcase is not possible, at least include a link to online live version of your application.
12-
* If your problem creates some visual glitch it helps to include a screenshot (highlight problematic area if problem is subtle).
13-
* What did you try already?
14-
* Search issue tracker for similar issues. Somebody else may have already filled an issue about your problem (in that case make a comment there instead of creating new issue). Or there may be other issues that seem similar, it helps if you can cross-reference them (mentioned in text hashed issue number like this `#1234`).
4+
Before reporting a bug
5+
---
6+
1. Search issue tracker for similar issues.
7+
2. Try the latest dev branch version of three.js.
8+
3. Refer to the [Migration Guide](https://github.com/mrdoob/three.js/wiki/Migration) when upgrading to the dev version.
159

16-
## How to contribute to three.js?
1710

18-
* Make sure you have a GitHub account.
19-
* Fork the repository on GitHub.
20-
* Check [contribution guidelines](https://github.com/mrdoob/three.js/wiki/How-to-contribute-to-three.js).
21-
* Make changes to your clone of the repository.
22-
* Submit a pull request.
11+
How to report a bug
12+
---
13+
1. Specify the revision number of the three.js library where the bug occurred.
14+
2. Specify your browser version, operating system, and graphics card. (for example, Chrome 23.0.1271.95, Windows 7, Nvidia Quadro 2000M)
15+
3. Describe the problem in detail. Explain what happened, and what you expected would happen.
16+
4. Provide a small test-case (http://jsfiddle.net). If a test-case is not possible, provide a link to a live version of your application.
17+
5. If helpful, include a screenshot. Annotate the screenshot for clarity.
18+
19+
20+
How to contribute to three.js
21+
---
22+
1. Make sure you have a GitHub account.
23+
2. Fork the repository on GitHub.
24+
3. Check the [Contribution Guidelines](https://github.com/mrdoob/three.js/wiki/How-to-contribute-to-three.js).
25+
4. Make changes to your clone of the repository.
26+
5. Submit a pull request.
2327

0 commit comments

Comments
 (0)