mirror of https://github.com/Awuqing/BackupX.git synced 2026-06-03 00:39:48 +08:00

Files

Wu Qing a6dd8033ed 文档: 新增 Docusaurus 官网与双语文档，README 切换为英文默认 (#39 )

- 新建 docs-site/ Docusaurus 项目，支持 en + zh-Hans 双语
- 从 README 迁移内容为独立文档页面：
  - Getting Started（安装、快速开始）
  - Deployment（Docker、裸机、Nginx、配置参考）
  - Features（备份类型、存储后端、SAP HANA、多节点集群、通知）
  - Reference（API、CLI）
  - Development（开发、贡献）
- 自定义 BackupX 主题色、logo、落地页组件
- 新增 .github/workflows/docs.yml，Actions 自动构建并发布到 GitHub Pages
- README.md 切换为英文，中文版挪到 README.zh-CN.md，两者均精简为导航型
- 配置站点 URL：https://awuqing.github.io/BackupX/

2026-04-17 13:19:41 +08:00

1.5 KiB

Raw Blame History

sidebar_position, title, description

sidebar_position	title	description
2	贡献指南	如何反馈问题、提出改进、提交 PR。

贡献指南

BackupX 使用 Apache License 2.0 开源，欢迎提交 Issue 与 Pull Request。

报告 Bug

在 github.com/Awuqing/BackupX/issues 提交 Issue，请附上：

BackupX 版本（backupx --version）
部署方式（Docker / 裸机 / 源码）
相关的备份任务类型和存储后端
复现步骤
问题发生时段的 stdout / backupx.log 片段

提议改动

对于重要功能或重构，建议先开 Issue 对齐方案，避免 PR 大改动后被 Review 回退。

提交 PR

Fork 仓库，创建主题分支（如 fix/windows-path-escape）
执行 make test 确认本地全通过
保持每个 PR 只做一件事
Commit message 使用中文，格式 类型: 简要描述：
- 功能: 新增审计日志模块
- 修复: 目录浏览器无法进入子目录
- 重构: 简化存储目标解密逻辑
- 类型：功能 / 修复 / 重构 / 文档 / 构建 / 测试
PR 标题和正文同样使用中文，描述"为什么"和"怎么做"，而非仅仅"做了什么"

代码规范

Go — 所有错误必须处理（禁止 _ = err），日志使用现有 zap，禁止生产路径中出现 fmt.Println
TypeScript — 严格模式，禁止隐式 any，遵循现有 ESLint/Prettier 配置
Commit 粒度 — 每个 commit 一件事，不要把顺手的小修改和功能代码混在一起

1.5 KiB Raw Blame History Unescape Escape