[![pipeline status](https://git.uino.com/uino-3dapplication/component/plugin-core/badges/develop/pipeline.svg)](https://git.uino.com/uino-3dapplication/component/plugin-core)
[![coverage report](https://git.uino.com/uino-3dapplication/component/plugin-core/badges/develop/coverage.svg)](https://git.uino.com/uino-3dapplication/component/plugin-core)

<div align="center">
     <a href="https://www.thingjs.com/guide/"><img width="200" src="https://www.thingjs.com/static/images/avatar.png"></a>
</div>
<div align="center">
    <img src="https://img.shields.io/badge/ThingJS-v2.0-brightgreen.svg" alt="ThingJS">
</div>

> 插件（Plugin）是ThingJS API 提供的一种更综合扩展方式，用户可以在插件中开发自定义脚本、使用组件、引用模型/图片等资源内容，对一个综合的业务功能进行封装和复用。

## 📦 安装

- 确保 npm 仓库地址为公司的地址：

```bash
npm config get registry
```

- 如果不是公司仓库地址，执行以下命令：

```bash
npm config set registry=https://npm.uino.cn/
yarn config set registry https://npm.uino.cn -g
```

- 确保 ThingJS 为 2.0 及其以上版本

```bash
ThingJS 2.0
```

- 安装

```bash
npm install
yarn add
```

- 建议使用[yarn](https://blog.csdn.net/yw00yw/article/details/81354533)安装，可以避免很多未知的问题

## 📖 开发指南

```bash
# open server
npm run serve
# build
npm run build
# publish
npm run pub
```

## 🔨 开发规范

- [FAQ]

## 🤝 贡献者

- 张馨
- 李斌
- 贺昱晧
- 闫超威
- 罗菲

## 🔻 目录结构

```

├── packages  // 插件开发集
│   ├── plugin1  // 插件包
│   |   └── components // 插件文件夹
│   │   |   ├── BaseAnimation.js // 动画组件
│   │   ├── package.json // 插件信息
│   │   ├── index.js // 入口文件

```

## 关于 Changelog

Changelog 会根据 git 提交信息自动生成，提交信息是采用 Angular 规范，格式如下：

```
# 格式
<type>(<scope>): <subject>

# 例子
fix(levelfly): 修复相机倾斜 bug
# 或 fix: 修复相机倾斜 bug
```

- 注意冒号的前面没有空格，后面有一个空格，且冒号是英文字符。
- scope 可以不填写。
- type 为 feat 或 fix 时，该 commit message 才会生成到 Changelog 中。
- 如果修改了多个组件，git 提交时的这条 commit message 也会生成到多个组件 Changelog 中。
