add CONTRIBUTING

This commit is contained in:
handongxun 2020-08-15 17:36:12 +08:00
parent beef1ec4f0
commit 0d38c1c39c

40
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,40 @@
# CONTRIBUTING
### 目录说明
```
collection (表目录)
├─opendb-*
│ ├─collection.json (表结构)
│ ├─data.json (可选初始化数据)
│ └─package.json (表信息)
├─...
database (表分类目录)
├─opendb-* (表分类)
│ ├─db_init.json (关联表)
│ └─package.json (分类信息)
├─...
```
#### collection/opendb-*/collection.json
```
{
schema: {}, // 参考 JSON Schema 规范
index: [] // 索引,参考 https://uniapp.dcloud.net.cn/uniCloud/cf-database?id=db-init
}
```
#### database/opendb-*/package.json
```
{
"name": "@opendb/opendb-mall",
"version": "0.0.1",
"description": "", // 表分类描述
"keywords": ["","",""], // 关键字,用于表搜索
"opendb": {
"type": "database", // 类别database 标识数据库
"title": "电商系统" // 标题
}
}
```