docs: update contributing guides

This commit is contained in:
krau
2025-04-18 21:12:44 +08:00
parent 609289c16a
commit 5bb3b595aa
3 changed files with 14 additions and 96 deletions

11
docs/docs/contribute.md Normal file
View File

@@ -0,0 +1,11 @@
# 参与开发
## 贡献新存储端
1. Fork 本项目, 克隆到本地
2.`config/storage` 目录下定义存储端配置, 并添加到 `config/storage/factory.go`
3.`types/types.go` 中添加新的存储端类型
4.`storage` 目录下新建一个包, 编写存储端实现, 然后在 `storage/storage.go` 中导入并添加它
5. 更新 `config.example.toml` 文件, 添加新的示例配置
*可能确实有点麻烦了 = =*

View File

@@ -31,3 +31,4 @@ nav:
- deploy.md
- help.md
- faq.md
- contribute.md