Interested in contributing? As an open source project, we'd appreciate any help and contributions! On top of the Networked-Aframe framework itself, you can also contribute to this related component:
- Join the WebXR Discord
- Select the #a-frame channel
If you're not sure how to do something with Networked-Aframe, please post a message on Discord.
- Search the issue tracker for similar issues.
- Specify the version of Networked-Aframe in which the bug occurred.
- Specify information about your browser and system (e.g., "Firefox Nightly on OS X")
- Describe the problem in detail (i.e., what happened and what you expected would happen).
- If possible, provide a small test case with StackBlitz, a link to your application, and/or a screenshot. You can fork the naf-project on StackBlitz.
Here's how to submit a pull request (PR):
- Have a GitHub account with SSH keys set up.
- Fork the repository on GitHub.
- Clone your fork of the repository locally (i.e.,
git clone git@github.com:yourusername/networked-aframe). - Run
npm installto get dependencies andnpm run devto serve the test examples. Follow this tutorial on how to get started - Create a branch to work in (i.e.,
git checkout -b mybranch). - 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). - If necessary, write unit tests and run with
npm run test. - Make sure your code follows codestyle of the rest of the project.
- If your commit changes the external API of Networked-Aframe update the documentation
- Submit a pull request to the master branch. If you head to the Networked-Aframe repository after running
git pushfrom earlier, you should see a pop up to submit a pull request. - Address review comments if any.
As per usual with open source, you would agree to license your contributions under the MIT License.
- Create something awesome with networked-aframe
- Publish your work to Github (and GitHub pages) so everyone can learn from your work.
- Share it on Discord on the #a-frame channel.
- Let A-Frame know about it so they can retweet it. For this just tweet your project with a small video to @aframevr
- For bonus points, write and publish a case study to explain how you built it.
- Invite yourself to the WebXR Discord.
- Select the #a-frame channel
- Help answer questions that people might have and welcome new people.
- Help respond to newly-filed GitHub discussions
If you want to hold an event and talk about WebVR, A-Frame and/or Networked-Aframe, check out the presentation kit.
Thanks so much for contributing and helping grow WebXR!