# AnovUI 贡献指南

AnovUI 是一套开源组件库，致力于为开发者、设计人员提供丰富的可视化大屏组件，可在基于 VUE 的项目上使用该组件库。

AnovUI 的成长离不开大家的支持，如果您愿意为 AnovUI 贡献代码或提供建议，请阅读以下内容。

## Pull Request 规范

- 请先 fork 一份代码到自己的项目下，不要直接在仓库下建分支。

- commit 信息要以`type(scope): message` 的形式填写，例如 `feature: 添加AnTable组件`。
    ##### 类型（type） 有以下几种可能： 
    * feature：新功能
    * fix：错误修复
    * style：格式、分号缺失等
    * docs：文档修改 
    * perf: 性能相关
    * test： 添加测试，不更改产品代码
    * build: 项目打包构建相关的配置修改
    * revert: 恢复上一次提交（回滚）
    * deps: 依赖相关的修改
    * wip: work in progress 工作中 还没完成
    * refactor：生产代码重构
    * release: 发版
    * chore: 其他修改（不在上述类型中的修改）

- 不要提交 `lib` 里面打包的文件。

- push 之前尽量使用 rebase 命令使 commit 更简洁。

- 确保是提交到 `dev` 分支，而不是 `master` 分支。

- 如果是修复 bug，请在 PR 中给出描述信息。

## 开发环境搭建

首先您的开发环境需要 Node.js 10+，yarn，建议使用 yarn 进行依赖包的安装。

```shell
git clone https://github.com/anov-team/anov-ui.git
npm run dev

# open http://localhost:8085
```

打包代码：

```shell
npm run dist
```

一般您不需要做打包操作，统一由我们来打包发布。

## 组件开发规范

- 所有组件都在 src/components 目录下。
- 新增一个组件可以参考组件模版 aTemplate 目录， 里面包含标准的组件目录结构以及文件。
- 一个组件包含三部分文件：index.vue(组件呈现文件)、config.js(右侧面板配置信息文件)、components.json(组件描述文件)。

## 代码规范

仅供参考 [前端代码规范](https://gitofrenlu.github.io/feguid.github.io/index.html)