Skip to content

Latest commit

 

History

History
78 lines (49 loc) · 3.5 KB

CONTRIBUTING.md

File metadata and controls

78 lines (49 loc) · 3.5 KB
Raw

Interested in contributing? As an open source project, we'd appreciate any help and contributions! On top of the Exokit engine itself, you can also contribute to any related projects.

Join the Community on Discord

Invite yourself to the Exokit Discord.

Get Help or Ask a Question

If you're not sure how to do something with Exokit, please ask in Discord.

File an Issue

  1. Search the issue tracker for similar issues.
  2. Specify the version of Exokit in which the bug occurred.
  3. Specify information about your browser and system (e.g., "Exokit v0.0.420 on OS X")
  4. Describe the problem in detail (i.e., what happened and what you expected would happen).
  5. If possible, provide a small test case with CodePen, a link to your application, and/or a screenshot.

Contribute Code to Exokit

Check out the issues labeled help wanted (easy) or help wanted (hard) for good issues to tackle. Here's how to submit a pull request (PR):

  1. Have a GitHub account with SSH keys set up.
  2. Fork the repository on GitHub.
  3. Clone your fork of the repository locally (i.e., git clone [email protected]:yourusername/exokit).
  4. Create a branch to work in (i.e., git checkout -b mybranch).
  5. Make changes to your fork of the repository, commit them, and push them (i.e., git add -A . && git commit -m 'My Changes (fixes #1234)' && git push origin mybranch).
  6. Submit a pull request to the master branch. If you head to the Exokit repository after running git push from earlier, you should see a pop up to submit a pull request.
  7. Address review comments if any.

As per usual with open source, you would agree to license your contributions under the MIT License.

Share your Work

  1. Create something awesome using Exokit.
  2. Publish your work to Github (and GitHub pages) so everyone can learn from your work.
  3. Share it on Discord, Twitter, etc.
  4. For bonus points, write and publish a case study to explain how you built it.

Update Documentation

If you catch a typo or error in the documentation, we'd greatly appreciate a pull request.

Add Examples to Documentation

We like to have simple and interesting examples listed on relevant documentation pages. If you have an example that might be useful in the documentation, request to add it!

Help Your Fellow Exokit users

On GitHub

Help respond to newly-filed GitHub issues

Curate and Make Efforts Known

We round up all the cool stuff happening with Exokit on the blog.

Spread the Word

If you want to hold an event and talk about WebXR and Exokit, check out the presentation kit.

Thanks so much for contributing and helping grow WebXR!