vitest-dev / docs-cn Goto Github PK
View Code? Open in Web Editor NEWVitest 中文文档
Home Page: https://cn.vitest.dev
License: MIT License
Vitest 中文文档
Home Page: https://cn.vitest.dev
License: MIT License
建议用 issue 列一个 tasks,将要翻译的内容拆分成小块,供想翻译的同学认领,同时也防止任务冲突
整个翻译流程分为以下几个阶段:
如未认领文档就直接翻译,容易出现撞车的情况。
因此,在翻译前务必进行任务认领。
认领任务,请到 Github Issues 选择想翻译的文档。翻译任务认领说明
选定要翻译的文档后,即可开始翻译。
先将 vitest-dev/docs-cn 的文档仓库 fork 为个人仓库(有增删改的权限)。
将 fork 后的仓库 download 至本地,如:
git clone https://github.com/<YOUR-GITHUB-NAME>/docs-cn/
在 clone 好的文档中找到你所认领的文章,即可开始翻译。
翻译完成后,请 push 至个人仓库。
git add
git commit -m 'docs(cn): 翻译的哪篇文章'
git push -u origin <翻译分支>
再创建 Pull Request 至 vitest-dev/docs-cn 仓库。
注意:在创建 Pull Request 时,请尽量勾选允许其他人进行修改,便于快速修改及合并。
至此翻译阶段就结束了。
翻译完成请评论 @校对者
校对中,如有疑问或翻译错误,校对者会给出建议。
Github 的 PR 的评论提供了 suggestion 的功能,校对者对某行给出校对建议后,如无异议,可以直接进行合并。
而如果改动点较多,需进行本地修改时,则在本地对对应的内容进行修改,并提交到个人仓库的翻译分支即可。
注意: 无需关闭 Pull Request,Pull Reuquest 会自动追踪你的修改。
校对完成后,校对者会对 PR 进行 Approve 操作,并进行 Pull Request 的合并。
当你的 Pull Request 被合并后,则代表流程结束。
如需再次翻译,或同时翻译多篇。
一次 pr 尽量只有一篇文章的翻译,便于回溯
保证个人仓库的 main 分支始终为最新
每次翻译新文章时,请基于 main 分支拉取新分支
更新个人仓库的分支
git remote add upstream https://github.com/vitest-dev/docs-cn.git
git fetch upstream
git checkout main
git merge upstream/main
由于是提取出来的文档,所以可能需要各位同学先去 官方仓库 看一下是否同步,不同步在进行翻译的工作。目前工作量可能比较大,实在不好意思,我在思考解决的方案了,如果各位同学有解决方案也可以告诉我!
十分感谢各位的帮忙!!
领取方式,在本 issues 下评论即可。
在 2024年2月7日
至 2024年2月18日
进行全部的翻译校对工作,根据目前的 #391 。
注意:
- 一次尽量只认领一篇,给其他小伙伴留些机会~
- 认领开始前,请务必阅读 翻译流程说明
- 如果在翻译的时候发现有任何未同步的地方,及时指出,谢谢!
从 Todo List 中选取未被人领取过的文章:
未被领取过:
领取过:
领取过,已完成:
领取方式,在本 issues 下评论即可。
认领任务格式:
Section | Title | 译者 | 完成时间
-- | -- | -- | --
guide | install | @elonehoo | 2022.05.06 - 2022.05.06
示例效果:
Section | Title | 译者 | 完成时间 |
---|---|---|---|
guide | install | @elonehoo | 2021.05.18 - 2021.05.20 |
当完成时,请修改自己的认领评论,添加 PR 信息:
Section | Title | 译者 | 完成时间 | PR |
---|---|---|---|---|
guide | install | @elonehoo | 2021.05.18 - 2021.05.20 | #49 |
Todo List:
因为非常炫酷的 Vitepress 升级了,所以咱的官方文档也跟着升级了,所以咱的中文文档也要跟着升级,已经开始进行该操作!请大家稍作等待,等升级完成在进行PR操作。
现在默认的和活跃的分支是 dev
,或许可以修改下 Wike
注意:
- 一次尽量只认领一篇,给其他小伙伴留些机会~
- 认领开始前,请务必阅读 翻译流程说明
- 如果在翻译的时候发现有任何未同步的地方,及时指出,谢谢!
从 Todo List 中选取未被人领取过的文章:
未被领取过:
领取过:
领取过,已完成:
领取方式,在本 issues 下评论即可。
认领任务格式:
Section | Title | 译者 | 完成时间
-- | -- | -- | --
guide | install | @elonehoo | 2022.05.06 - 2022.05.06
示例效果:
Section | Title | 译者 | 完成时间 |
---|---|---|---|
guide | install | @elonehoo | 2021.05.18 - 2021.05.20 |
当完成时,请修改自己的认领评论,添加 PR 信息:
Section | Title | 译者 | 完成时间 | PR |
---|---|---|---|---|
guide | install | @elonehoo | 2021.05.18 - 2021.05.20 | #49 |
目前的 main 分支是之前的,跟官方文档产生了严重的脱节。
现在的 dev 分支是最新版的,并且后期会每天与官方文档进行同步。
请fork项目之后,将分支调整为 dev 的分支。
$ git checkout dev
将翻译完成的文档 PR 到dev分支。
Todo List:
guide
config
api
针对 官方文档 中的一些技术单词的翻译讨论
今天下午开始我会全力进行同步官方文档的任务,可能到时候会将各位的翻译直接照搬,有一个 commit 的覆盖问题,不知道各位是否在意这个事情?
@BTBMan @alexzhang1030 @ouduidui @baboon-king @jp-liu @zhangzhibang0309
注意:
- 一次尽量只认领一篇,给其他小伙伴留些机会~
- 认领开始前,请务必阅读 翻译流程说明
- 如果在翻译的时候发现有任何未同步的地方,及时指出,谢谢!
从 Todo List 中选取未被人领取过的文章:
未被领取过:
领取过:
领取过,已完成:
领取方式,在本 issues 下评论即可。
认领任务格式:
Section | Title | 译者 | 完成时间
-- | -- | -- | --
guide | install | @elonehoo | 2022.05.06 - 2022.05.06
示例效果:
Section | Title | 译者 | 完成时间 |
---|---|---|---|
guide | install | @elonehoo | 2021.05.18 - 2021.05.20 |
当完成时,请修改自己的认领评论,添加 PR 信息:
Section | Title | 译者 | 完成时间 | PR |
---|---|---|---|---|
guide | install | @elonehoo | 2021.05.18 - 2021.05.20 | #49 |
Todo List:
api/toThrowErrorMatchingSnapshot
translation #49欢迎 @watonyweng 加入Vitest 中文文档的翻译维护团队
👏欢迎参与 Vitest 的文档协作工作中,以下内容仅仅只适用于参与 vitest-dev/docs-cn 仓库的协作,在此之前,劳烦阅读完以下全文。
$ git clone [email protected]:vitest-dev/docs-cn.git
$ cd docs-cn
$ pnpm install
$ pnpm run dev
在完成翻译后,发起 PR
即可,在文档翻译长期维护的开发者确认无误后,将合并入主仓库,访问域名:cn.vitest.dev 。
建议 message 使用英文,关键词后加英文冒号,再加空格,一段话描述,如:
style: fix the strong style for Chinese characters
chore: update yarn.lock
review: introduction
具体参考旧 Pull Request 建议标题使用英文,可以在描述里使用中文描述详细的特性。
目前网站即将处于待校对的状态,细则详见:#393
英文文档的所在 请点击此链接,我们会每天拉取英文版文档内容的更新到 sync-docs 分支,并由印记中文 bot 自动发起 Pull Request ,解决 Git 冲突并翻译内容。
发现有些段落翻译晦涩难懂?
在搜索未得到相关讨论结果后,可发起 issue,有结论后,我们定期汇总至该 issue
如果有一个章节很长,我只翻译了一半,后续不想翻译了?
虽然允许,但,我个人还是希望,最好以一个 .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 type | 建议翻译 |
---|---|
info | 说明 |
warning | 注意 |
tip | 提示 |
danger | 警告 |
details | 详情 |
开启一个新的 issue 与大家一起讨论,在有了结果之后,会将结果同步到该 issue 中。
ps. 文档翻译长期维护的开发者「排名不分先后」
文档同步后有一处还没翻译的地方,我有机会贡献一波吗
@elonehoo
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.