vitest-dev/docs-cn

翻译须知

Opened this issue · 0 comments

elonehoo commented

Vitest 翻译须知

👏欢迎参与 Vitest 的文档协作工作中，以下内容仅仅只适用于参与 vitest-dev/docs-cn 仓库的协作，在此之前，劳烦阅读完以下全文。

协作指南

准备参与

开发

$ git clone git@github.com:vitest-dev/docs-cn.git
$ cd docs-cn
$ pnpm install
$ pnpm run dev

在完成翻译后，发起 PR 即可，在文档翻译长期维护的开发者确认无误后，将合并入主仓库，访问域名：cn.vitest.dev 。

commit message 规范

建议 message 使用英文，关键词后加英文冒号，再加空格，一段话描述，如：

  • style: fix the strong style for Chinese characters
  • chore: update yarn.lock
  • review: introduction

Pull Request 标题规范

具体参考旧 Pull Request 建议标题使用英文，可以在描述里使用中文描述详细的特性。

参与贡献

翻译和校对

集中翻译和校对

目前网站即将处于待校对的状态，细则详见：#393

定期翻译和校对从英文站同步过来的新内容

英文文档的所在 请点击此链接，我们会每天拉取英文版文档内容的更新到 sync-docs 分支，并由印记中文 bot 自动发起 Pull Request ，解决 Git 冲突并翻译内容。

除了翻译和校对

  • 定期从英文版同步：包括最新的翻译和非文档内容的代码同步，可以随时发起 PR
  • 网络环境和本地化：如果发现任何这方面的问题可以直接发起 issue 讨论
  • 翻译讨论：可以随时发起 issue 讨论

注意事项

  • 尽量保持原文的编码风格，不产生不必要的格式变化和改动。如果对格式有异议，建议直接在英文站讨论。
  • 同步最新的翻译时，建议先查阅是否有印记中文 bot 所产生的 Pull Request。

常见问题

  1. 发现有些段落翻译晦涩难懂？
    在搜索未得到相关讨论结果后，可发起 issue，有结论后，我们定期汇总至该 issue

  2. 如果有一个章节很长，我只翻译了一半，后续不想翻译了？

    虽然允许，但，我个人还是希望，最好以一个 .md 文件为单位来发起 PR，避免后续来回追踪。

翻译须知

术语翻译约定

英文 建议翻译 资料
you 你 (而不用“您”)
mock(n.) 模拟对象
mock(v.) 对象模拟
spy(v.) 对象监听
in-source testing 源码内联测试
test suite 测试套件
test 测试；与 Test suite 共同出现时建议翻 测试用例
feedback loop 反馈循环
code coverage 代码覆盖率
module graph 模块依赖树
headless logic/code 非浏览器逻辑

中文术语约定

中文 约定的写法
应用程序 应用
开发人员 开发者
其他/其它 统一到“其他”
举个例子 举例来说

Alert 术语约定

alert type 建议翻译
info 说明
warning 注意
tip 提示
danger 警告
details 详情

如何增加 术语翻译阅读 的内容

开启一个新的 issue 与大家一起讨论，在有了结果之后，会将结果同步到该 issue 中。

ps. 文档翻译长期维护的开发者「排名不分先后」