Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 1.85 KB
Raw

Join the Community on Slack

  1. Invite yourself to the A-Frame Slack channel.
  2. Join the discussion!

Filing an Issue

  1. Search the issue tracker for similar issues.
  2. Specify the version of A-Frame 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 small test case with Codepen, a link to your application, and/or a screenshot. You can fork this sample pen.

Contributing Code to A-Frame

Check out the issues labeled easy for good issues to tackle.

  1. Have a GitHub account.
  2. Fork the repository on GitHub.
  3. Run npm install and npm run dev to serve the test examples.
  4. Make changes to your fork of the repository.
  5. If possible, write a unit test and run with npm test.
  6. Submit a pull request to the master branch.
  7. Address review comments and squash your commits once ready.

Please note you would agree to license your contributions under the license.

Sharing your Work

  1. Create something awesome like a scene, a component, or a shader.
  2. Publish your work to Github (and GitHub pages) so everyone can learn from your work.
  3. Share it on Slack and the awesome-aframe repository.
  4. Rack up the Github stars!

Thanks for contributing!