Files
BackupX/docs-site/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/contributing.md
Wu Qing 66373fa8e4 修复: 中文 i18n 目录名从 zh-Hans 改为 zh-CN,首页 SSR 翻译现已生效 (#42)
Docusaurus 3.10 会把 locale id 'zh-Hans' 规范化为 BCP 47 的 'zh-CN' 来
读取 i18n/ 目录。之前手工创建的 i18n/zh-Hans/ 目录 Docusaurus 识别不到,
导致中文版 SSR 输出仍是英文字符串,只有 URL 路由 /zh-Hans/ 生效。

同时修复 index.tsx 中 <Translate id={labelId}> 动态 id 问题:
write-translations 工具要求静态字符串,已拆分为三个独立的 Translate 元素。
2026-04-17 13:52:16 +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

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

代码规范

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