VS-Code-Extension-Doc-ZH
VS-Code-Extension-Doc-ZH copied to clipboard
🎉 欢迎各位读者!!!
随着 VS Code 不断迭代和生态日益壮大,我们已经正式推出了 本文档的 1.0 版本。 你也可以随时从本项目的 README 入口进入中文版翻译。
初衷
本文档纯属个人兴趣爱好,维护文档的工作也是在日常工作中抽空去做的,如有任何建议请不吝赐教,当然如果你对本项目owner 和所在公司或者行业感兴趣,也欢迎邮件咨询 iaserrlin at 163.com。
纠错
承蒙大家的厚爱,随着中文文档内容的不断充实,目前 star 数量也在日益增长,我们也深知自己的能力和精力都非常有限,在翻译工作中难免有所疏忽,如果你对我们的翻译内容有更好的意见,或是找到了我们工作中的错误,请在issue 中指出我们的错误, 甚至为我们提供 PR。
原则和常见问题
- VS Code 已经提供了非常多的开发问题答疑渠道。
- 如果你有关于插件开发的具体细节和实现需要讨论,请进入我们的讨论区,本项目不开设任何相关讨论群(qq, 钉钉,微信等),请勿在此处发布或者宣传。具体的开发问题,可以参考 VS Code 官方提供的
Stack Overflow
中 VS Code 相关问题标签、Gitter 频道 和 VS Code Dev Slack 讨论区。 - 目前我们的工作进度可通过 项目进度 查看。
翻译指南
由于原文档过于追求平白易懂,平添了许多反复解释和略显啰嗦的句子和语法,翻译者需要注意,本项目更追求易懂和流畅,不要求逐字翻译,与原文出入最低做到70%即可,但不可扭曲其原本的意思,任何翻译中的困难可在issue中探讨。
-
及时更新术语表
-
禁止机器翻译
-
约定用法 如Promise通常不做翻译,若有必要或遇到困难的词语,请使用“中文(English)”的方式来显示,如:
异步请求(promise)
,在有参考资料后得出的翻译结果,需要在术语表释义后面注明词汇出现来源或释义链接。 -
避免冗余
By implementing a `WebviewPanelSerializer`, your webviews can be automatically restored when VS Code restarts. Serialization builds on `getState` and `setState`, and is only enabled if your extension registers a `WebviewPanelSerializer` for your webviews.
后一句
and is only enabled if your extension registers a WebviewPanelSerializer for your webviews
再翻译出来显得多余,可以不翻译。 -
平白易懂
Consider using a helper library to construct your HTML strings, or at least ensure that all content from the user's workspace is properly sanitized.
虽然这里HTML 字符串贴合
HTML strings
的表述,但是适当的加工则更有利于阅读,最终可考虑翻译为“尝试使用辅助库构建你的HTML模板,或者确保所有来自用户工作区的内容都通过了审查”。 -
兼收并蓄
在多人合作翻译中,个人风格可能与已提交翻译不匹配,但这种情况下不建议修改现有的翻译成果。
-
术语翻译优先参考github的开源翻译项目
开发指引
本项目依赖nodejs,npm,docsify和官方文档。另外对新手不太友好(萌新等级警告⚠️请勿轻易尝试)。
贡献代码
- Markdown的格式要求,尽量避免使用
*
用于表示列表,而是使用-
等其他符号 - 贡献流程:fork/clone本项目,根据目前的项目进度和自己的兴趣,挑选进行中的翻译,在issue面板中创建一个
help translate
告知项目owner,通过后创建分支如“fix/chapter_testing_extensions”,修改文件,提交pr到“branch/docs” - 请在翻译中遵循翻译指南,否则本项目的owner可能会与你进行深度的讨论~
// 本地启动开发
npm i docsify-cli -g
docsify serve docs
这里文字错了