Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

30 lines (24 loc) · 1.85 KB
Raw

Thanks for getting involved!

Please note that the GitHub issue tracker is not meant for general Q & A or usage questions. Please post those types of questions to the PicoGL.js Gitter chat room.

Also note that the scope of PicoGL.js is limited specifically to managing GL state, so requests for features outside of that scope (math utilities, physics, scene data structures) will not be accepted. Also note that requests for cosmetic changes (style, frameworks) will not be accepted. New features should have a meaningful impact on functionality or performance.

Reporting a Bug

  1. Search the issue tracker to make sure the bug hasn't already been reported.
  2. Provide a detailed description of the problem, along with steps to reproduce.
  3. Provide a jsFiddle demonstrating the problem.
  4. Provide relevant system information: browser/version, OS/version, GPU/driver version. This should all be available via chrome://gpu in Chrome or about:support in Firefox.

Requesting a Feature

  1. Search the issue tracker to make sure the feature hasn't already been requested.
  2. Describe the feature and a relevant use-case for it.

Contributing

  1. Fork the repository.
  2. Run npm install to install required development packages.
  3. Create a branch with an appropriate name in your fork.
  4. Maintain a similar style to the rest of the code base.
  5. Make your updates.
  6. You can run npm run dev-build to build and generate a source map that will simplify debugging.
  7. Run npm run build and ensure that all examples in /examples/ and all tests on /test/index.html function properly.
  8. Commit your changes and push them to GitHub.
  9. Make a pull request against master.