Skip to content

合作规范

Jump to bottom
Wayne Zhang edited this page Jun 25, 2025 · 5 revisions

翻译理念

我们应秉持一种「相对克制、达意为先，促进应用，尽可能雅致」的翻译理念。

  • 首先应尽可能地与英文原意保持一致，若遇到英语独有的表达方式，再根据相应前端工作方面的概念选用意译。
  • 标点符号请遵守中文形式和本 Wiki 内的【格式规范】
  • 英语语法常见于定语、修饰语后置，在翻译为中文时尽可能进行倒装变换，但力求即使口语也能阅读通顺。
  • 尽可能将一些特定概念降维，使得入门级读者也能够流畅阅读，最好能够更生动化、口语化，力求直观。

贡献方式

  1. 首先您应该 fork 本仓库到您的 Github 账号下
  2. 使用 Git 克隆您的 fork 仓库的最新版本到本地，并按照文档提示安装好依赖。
  3. 使用 git checkout -b <your_branch_name> 新建一个分支，作为您的修改贡献工作分支

... 进行您的修改工作

  1. 在 git commit 时请参阅 【提交规范】 书写符合格式要求的 commit message，否则您的提交可能会被驳回
  2. 在 git push 提交到您的远端 fork 仓库后，向 docs-cn 仓库的 main 分支发起一个 Pull Request

PR 分支选择

  1. 修复线上文档问题，请 PR 到 main 分支
  2. 处理英文主文档内容更新，请 PR 到每日同步的 sync-xxx 分支

VSCode 配置建议

为了避免您的编辑器有自带的 Lint 行为，对文档（尤其是示例代码）造成大面积的不必要更改， 请将下面的代码插入到您的 VSCode 设置文件 settings.json 中：

"prettier.singleQuote": true,
"prettier.semi": false,
"prettier.trailingComma": "none"

Review 意见参考

我们会在 Review 评论中带上以下的 Tag 来给贡献者做提示。

  • 请求修改 —— 是格式内容等不符合相应规范
  • 仅作讨论 —— 您可以考虑更改或保留自己的意见，我们对此持开放态度

Clone this wiki locally