angle icon indicating copy to clipboard operation
angle copied to clipboard

prepare for aframe-registry

Open 7dir opened this issue 7 years ago • 0 comments

https://github.com/aframevr/aframe-registry

Component Requirements

  1. Must be published to npm.
  2. Must be published to GitHub.
  3. Must self-register themselves with AFRAME.registerComponent.
  4. Must contain documentation on component properties and sample usage in the README.
  5. Must contain at least one example published to GitHub Pages.
  6. A link to the examples must be added as the GitHub repository's Website next to the GitHub repository's Description.
  7. Must make sense in the context of a WebVR application. This can change later, but the initial components of the Registry will be under strict curation.

Component Suggestions

  • Should include an attractive preview image or GIF in your README for display.
  • Should follow semver in your component versioning scheme, mirroring A-Frame's latest stable version.
  • Use angle, an A-Frame command-line tool, to bootstrap a component template for publishing.
  • Add A-Frame Registry maintainer Kevin Ngo as a collaborator to your GitHub repository and as an owner to your npm package (npm owner add ngokevin) if you want help maintaining your component.

7dir avatar Jun 16 '17 23:06 7dir