TranslationHelp.md

翻译帮助指南

本文档旨在帮助翻译贡献者参与项目的英文到简体中文的翻译工作。

翻译规范

基本要求

• 确保翻译准确性，避免意思歧义
• 保持专业术语的一致性
• 遵循中文的语言习惯和表达方式
• 保持文档格式的一致性
• 保持原文的段落结构
• 确保链接可正常访问

专业术语处理

• 首次出现的专业术语采用"中文（英文）"的形式
• 建立术语表，保持翻译一致性
• 以下内容保持英文原样：
  • 编程语言名称（Python, JavaScript 等）
  • 框架名称（React, Vue 等）
  • 专有名词（Git, GitHub 等）
  • 代码示例及其注释

格式要求

• 保持原文档的 Markdown 格式
• 代码块内容不翻译
• 保留原文档的链接引用
• 图片说明文字需要翻译
• 保持原文的缩进和空行
• 确保 Markdown 语法正确

文件覆盖规则

• 翻译文件直接覆盖原英文文件
• 翻译前请确保已备份原文件内容
• 保持文件名和路径不变
• 确保文件编码为 UTF-8

分支管理规范

分支命名规范

• 格式：translate/[文档路径]
• 示例：

  translate/docs/getting-started
  translate/api/authentication
  translate/tutorial/basic
  

分支创建流程

1. 同步主分支

   git checkout main
   git pull origin main

2. 创建翻译分支

   git checkout -b translate/[文档路径]

提交规范

Commit 信息格式

docs(translate): 翻译说明

例如：
docs(translate): 完成入门教程翻译
docs(translate): 修正 API 文档翻译错误

提交建议

• 每次提交专注于单个文档的翻译
• 提交前进行本地预览测试
• 确保没有语法错误
• 保持提交粒度适中，便于审核

Pull Request 规范

PR 命名规范

docs(translate): 文档名称翻译

PR 描述模板

### 翻译内容
- 文件路径：
- 相关 Issue：

### 翻译检查清单
- [ ] 已检查专业术语一致性
- [ ] 已进行本地预览测试
- [ ] 保持了原文格式
- [ ] 确保文件编码为 UTF-8
- [ ] 添加了必要的注释

### 其他说明
（如有其他需要说明的内容）

PR 审核流程

1. 提交 PR 后，请求至少一名审核者进行审核
2. 审核者检查内容：
   • 翻译准确性
   • 专业术语使用
   • 格式规范
   • 文档完整性
3. PR 作者根据反馈进行修改
4. 获得批准后合并到主分支

审核标准

• 翻译准确性：不改变原文含义
• 语言流畅性：符合中文表达习惯
• 专业性：术语使用准确一致
• 格式规范：符合项目文档规范

Issue 提交规范

Issue 类型

• 翻译错误：translation-error
• 翻译改进：translation-improvement
• 术语讨论：terminology

Issue 内容模板

### 类型
[选择类型]

### 文档信息
- 文件路径：
- 行号（如适用）：

### 具体问题/建议
（详细描述）

### 建议的修改
（如果有）

翻译工作流程

1. 准备工作

   • 查看现有 issue 和翻译进度
   • 确认没有重复工作
   • 了解项目术语表

2. 任务认领

   • 在相关 issue 下评论认领
   • 等待管理员确认分配

3. 开始翻译

   • 创建新分支
   • 备份原文件内容
   • 进行翻译工作
   • 覆盖原文件

4. 提交翻译

   • 创建 Pull Request
   • 完成 PR 描述
   • 请求审核

5. 完成合并

   • 根据审核意见修改
   • 等待最终批准
   • 合并到主分支

翻译质量保证

自查清单

• 翻译是否准确传达原文意思
• 专业术语使用是否一致
• 中文表达是否通顺自然
• 格式是否符合规范
• 链接是否正常工作
• 文件编码是否正确

常见问题

1. 专业术语不一致
2. 中文表达不通顺
3. 格式错误
4. 文件编码错误
5. 遗漏内容

联系与帮助

如有任何问题，可以：

• 在相关 issue 中提问
• 在 PR 中讨论
• 通过项目维护者联系方式获取帮助

资源链接

• 项目主页
• 翻译进度
• 翻译难度表

---

本文档会持续更新，欢迎提供建议和改进意见。