Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx --no-install commitlint --edit "$1"
43 changes: 43 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1,44 @@
# 贡献指南

感谢您对本项目的贡献!为了保持提交记录的整洁,请遵循以下提交信息格式:

提交信息应包括三个部分:
1. 类型 (type)
2. 作用域 (scope)
3. 简短的描述 (subject)

格式如下:
```
<type>(<scope>): <subject>
```

示例:
```
feat(auth): #1 add login functionality
fix(profile): #2 correct user age calculation
docs(readme): update installation instructions
```

## 类型
- feat: 新功能
- fix: 修复 bug
- docs: 仅文档更改
- style: 不影响代码含义的更改(空白、格式、缺少分号等)
- refactor: 代码重构,既不修复错误也不添加功能
- test: 添加缺失的测试或更正现有测试
- chore: 其他不修改 src 或测试文件的更改

## 作用域
- 用于说明提交更改的影响范围,例如模块或功能。

## 描述
- 简短的描述,说明更改的目的。

## 关联 Issue
- 如果提交是为了关闭某个 issue,请在描述中包括 issue 编号。
- 格式为 `#<issue_number>`,例如:`feat(auth): #1 add login functionality`。

## 感谢
> 以下是参与贡献的伙伴们,感谢各位的付出。让 `diskcloud` 变得更加完善和强大。

<a href="https://github.com/diskcloud/service/graphs/contributors"><img src="https://opencollective.com/diskcloud/contributors.svg?width=890" /></a>
3 changes: 3 additions & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
extends: ["@commitlint/config-conventional"],
};
6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,19 @@
"prod": "pm2 start index.js --name upload-file-service --watch",
"del": "pm2 delete upload-file-service",
"log": "pm2 logs upload-file-service",
"dev": "nodemon index.js"
"dev": "nodemon index.js",
"prepare": "husky install"
},
"dependencies": {
"@commitlint/cli": "^19.3.0",
"@commitlint/config-conventional": "^19.2.2",
"@koa/cors": "^5.0.0",
"axios": "^1.7.2",
"bcrypt": "^5.1.1",
"dotenv": "^16.4.5",
"file-type": "^19.0.0",
"filesize": "^10.1.2",
"husky": "^9.0.11",
"joi": "^17.13.3",
"jsonwebtoken": "^9.0.2",
"jszip": "^3.10.1",
Expand Down
Loading