# manage-my-media

**Repository Path**: cvpv/manage-my-media

## Basic Information

- **Project Name**: manage-my-media
- **Description**: 一款基于web的本地多媒体资源管理与呈现系统，正在开发中。
- **Primary Language**: JavaScript
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-06-14
- **Last Updated**: 2022-09-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# manage-my-media

#### 项目背景

一款基于web的本地多媒体资源管理与呈现系统，正在开发中。

#### 环境依赖

Node.js

#### 安装

待完善

#### 使用

后端启动：```待完善```

#### 目录结构

```            
├── service                  # 后端项目目录
├── web                      # 前端项目目录
├── LICENSE
└── README.md
```


#### Git commit 规范

Git commit 消息尽量按照约定式提交规，进行规范的提交。

结构如下：

```            
<type>(<scope>): <short summary>
// 空一行
[body]
// 空一行
[footer]
```

**header 部分**

第一行是 header 部分，必须使用类型字段前缀，它由一个名词组成，只能是下面几种之一：
* feat: 新功能
* fix: 修复bug
* docs：只改动了文档
* style：修改代码格式（例如去掉空格、改变缩进、增删分号，不影响代码逻辑）
* refactor：重构代码（理论上不影响现有功能）
* perf：提升性能的改动
* test：增加修改测试用例
* chore：改变构建流程、或者增加依赖库、工具等
* revert：回滚到上一个版本
* ci：持续集成
* build：构建版本

其后接一个可选的作用域字段，作用域必须是一个描述某部分代码的名词，并用圆括号包围，例如： fix(parser)。每个项目的作用域都不一样，在基于 lerna 的 monorepo 仓库中，通常用 package 名称作为 scope。
然后紧接着一个冒号（英文半角）和空格。
最后是简短描述，建议不要超过 50 个字符。
总结如下：

```
<type>(<scope>): <short summary>
  │       │             │
  │       │             └─⫸ 描述：指的是对代码变更的简短总结
  │       │
  │       └─⫸ 作用域: animations|bazel|benchpress|common|compiler|...
  │
  └─⫸ 提交类型：build|ci|docs|feat|fix|perf|refactor|test...
```

**body 部分 (该部分可省略)**

Body 部分是对本次 commit 的详细描述，可以分成多行，提交者自由发挥。

**footer 部分 (该部分可省略)**
footer 部分一般用于记录不兼容的改动，以 BREAKING CHANGE 开头，后面是对变动的描述、以及变动理由和迁移方法。最后还可以添加关闭的 issue。

```
BREAKING CHANGE: <breaking change summary>
// 空一行
<breaking change description + migration instructions>
// 空一行
// 空一行
Fixes #<issue number>
```