CONTRIBUTING.md 1.5 KB

Help

The issues section is for bug reports and feature requests only. If you need help, please use the forum or stackoverflow.


Bugs

Before reporting a bug

  1. Search issue tracker for similar issues.
  2. Try the latest dev branch version of three.js.
  3. Refer to the Migration Guide when upgrading to the dev version.

How to report a bug

  1. Specify the revision number of the three.js library where the bug occurred.
  2. Specify your browser version, operating system, and graphics card. (for example, Chrome 23.0.1271.95, Windows 7, Nvidia Quadro 2000M)
  3. Describe the problem in detail. Explain what happened, and what you expected would happen.
  4. Provide a small test-case (http://jsfiddle.net). Here is a fiddle you can edit that runs the current version. And here is a fiddle that uses the dev branch. If a test-case is not possible, provide a link to a live version of your application.
  5. If helpful, include a screenshot. Annotate the screenshot for clarity.

Contribution

How to contribute to three.js

  1. Make sure you have a GitHub account.
  2. Fork the repository on GitHub.
  3. Check the Contribution Guidelines.
  4. Make changes to your clone of the repository.
  5. Submit a pull request. Don't include build files in the PR.