第三方插件(组件)开发(移植)规则

LW edited this page Nov 8, 2016 · 7 revisions

基本规则

  • 样式风格与 Amaze UI 保持一致;
  • 移植的插件务必注明源插件的开源许可;
  • 发布到 NPM 并在 keywords 中添加相应关键字:
    • Amaze UI Web:添加 amazeui-plugin
    • Amaze UI React:添加 amuireact-component
    • Amaze UI Touch:添加 amuitouch-component
  • 提供可在线查看的项目主页,项目主页中应包含组件介绍、API 文档及演示;
  • 承担组件支持、维护的责任,如回复用户问题、修复 bug 等。

代码规范

作为第三方插件,我们并不要求遵守 Amaze UI 的代码规范,但是请保持代码风格的一致性。如果没有自己的偏好,那可以使用 Airbnb 这类的比较流行的代码风格及配套的 lint 工具。

插件提交

Amaze UI官网上为大家提供了第三方移植插件的集合平台 — 插件库, 如果您的插件想在这里展示。请发送插件的Github地址到amazeui@yunshipei.com

参考链接: