Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 3.23 KB

CONTRIBUTING.md

File metadata and controls

64 lines (42 loc) · 3.23 KB
Raw

Interested in contributing? AR.js Studio is an open source project with the goal of remove the barrier of coding knowledge so everyone can easily create, deploy, and share AR projects with the world.

Join the Community on Slack

  1. Invite yourself to the AR.js Studio Slack channel.
  2. Join the discussion!

Get Help or Ask a Question

If you're not sure how to do something with AR.js studio, please let us know by sending an email, filing an issue, posting your question on Slack or answering this form.

File an Issue

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

Contribute Code to AR.js Studio

Check out the issues labeled 1.0.0 or hacktoberfest 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 git@github.com:yourusername/studio).
  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 against the master branch. If you head to the AR.js Studio 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!.
  2. Publish your work to Github (and GitHub pages) so everyone can learn from your work.

Help Your Fellow Contributors

On Slack

  1. Invite yourself to the AR.js Studio Slack channel.
  2. Help answer questions that people might have and welcome new people.

On GitHub

  1. Help respond to newly-filed GitHub issues

Spread the Word

If you want to hold an event and talk about WebAR and AR.js Studio, check out the design kit.

Thanks so much for contributing and making WebAR happen!