mirror of https://github.com/Awuqing/BackupX.git synced 2026-05-27 19:19:35 +08:00

Files

Wu Qing e4c52fd8f4 docs: 新增 CONTRIBUTING 贡献指南 (#73 )

补充开发环境搭建、构建/测试命令、Conventional Commits（中文）规范、
PR 流程与编码约定。内容与仓库实际一致（Go 1.25、make 目标、vitest
前端测试、后端自动托管 web/dist）。

承接 #64 的思路并重写为与代码库一致的准确版本（不含 #63/#64 中关于
`-e PORT` 等不准确的 troubleshooting 内容）。

Co-authored-by: okwn <13228820+okwn@users.noreply.github.com>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

2026-05-26 12:56:43 +08:00

3.1 KiB

Raw Blame History

Contributing to BackupX

感谢你对 BackupX 的关注！本指南介绍如何搭建开发环境并提交贡献。 Thanks for your interest in contributing to BackupX! This guide covers how to set up your environment and submit changes.

开发环境 / Development Setup

依赖 / Prerequisites

Go 1.25+（见 server/go.mod）
Node.js 20+（CI 与 Docker 使用 Node 20）
npm 9+

快速开始 / Quick Start

分别在两个终端启动前后端（后端 :8340，前端 Vite HMR）：

git clone https://github.com/Awuqing/BackupX.git && cd BackupX

# 终端 1 —— 后端（默认 http://localhost:8340）
make dev-server

# 终端 2 —— 前端（Vite 热更新，/api 代理到 8340）
make dev-web

构建 / Building

make build          # 同时构建后端与前端
make build-server   # 仅后端 → server/bin/backupx
make build-web      # 仅前端 → web/dist
make docker         # 构建 Docker 镜像
make docker-cn      # 国内镜像源加速构建

后端会自动托管 web/dist（或 server.web_root 指定目录），因此本地裸机部署无需额外的反向代理即可访问控制台。

测试 / Testing

提交前请确保测试通过：

make test           # 后端 + 前端全部测试
make test-server    # 仅后端：cd server && go test ./...
make test-web       # 仅前端：cd web && npm run test（vitest）

新增功能或修复缺陷时，请尽量补充对应测试。

提交信息规范 / Commit Messages

本项目采用 Conventional Commits，正文用中文撰写：

<type>(<scope>): <subject>

<body>

type	说明
`feat`	新功能
`fix`	缺陷修复
`docs`	文档变更
`style`	不影响逻辑的格式调整
`refactor`	重构
`perf`	性能优化
`test`	测试相关
`chore`	构建/依赖/工具链

示例：

feat(storage): 新增 Wasabi S3 后端支持
fix(cluster): 修复跨节点恢复的终态处理
docs: 补充 CONTRIBUTING 指南

Pull Request 流程

Fork 仓库并从最新的 main 切出特性分支；
开发功能或修复，必要时补充测试；
自测：确保 make test 通过；
提交：使用上述 Conventional Commits（中文）；
推送并对着 main 发起 PR。

PR 描述建议

清晰说明本 PR 做了什么；
对新功能/修复，补充动机与背景；
关联相关 Issue（如 Closes #62）；
纯文档 PR 可不附测试。

请保持分支基于较新的 main：基线过旧的分支容易产生大范围冲突，难以评审与合入。

编码规范 / Coding Conventions

Go：所有错误必须处理（禁止 _ = err），日志使用项目已有库（zap），禁止 fmt.Println；提交前执行 gofmt。
前端：遵循项目 ESLint/Prettier/tsconfig 配置，不擅自引入新的 CSS 框架或 UI 库。
包管理：web/ 使用 npm，请提交对应的 package-lock.json。

License

向 BackupX 贡献即表示你同意你的贡献以 Apache License 2.0 授权。

3.1 KiB Raw Blame History Unescape Escape