mirror of
https://github.com/rust-lang-cn/book-cn.git
synced 2025-01-22 23:10:20 +08:00
Update README.md and CONTRIBUTING.md
This commit is contained in:
parent
cdf1f47eec
commit
9f9236766a
@ -1,38 +1,43 @@
|
||||
# Contributing
|
||||
# 参与贡献
|
||||
|
||||
We're currently working with No Starch Press to bring the book to print. Each
|
||||
chapter goes through [a number of stages][project]:
|
||||
若您对此书想参与贡献,您可以对此书的英文原版或中文翻译版的项目各自提出问题、建议或合并请求。
|
||||
|
||||
## 参与本书中文翻译
|
||||
|
||||
目前本书的翻译正在进行中,英文原版的文档也仍在撰写,所以翻译的初始版本完成要到英文第一版编好后方可完成。
|
||||
|
||||
想参与翻译的同学最好先在本中文翻译项目的 issue 区提出参与翻译,可以商讨分工合作,然后翻译的指定部分,以避免不同人翻译了相同的章节内容。当然也欢迎将已经翻译好的内容提出合并请求。
|
||||
|
||||
为了使 Rust 术语的译文保持前后合理一致,请参与翻译的朋友在遇到 Rust 相关术语时先查阅[《Rust 语言术语中英文对照表》][rust-glossary],若是对照表中没有出现 Rust 的相应术语,随时欢迎您翻译过程中扩充对照表的术语。
|
||||
|
||||
另外在简体中文排版时,大家可以参考[《中文排版指南》][chinese-copywriting-guidelines]。
|
||||
|
||||
[rust-glossary]: https://github.com/rust-lang-cn/english-chinese-glossary-of-rust/blob/master/rust-glossary.md
|
||||
[chinese-copywriting-guidelines]: https://github.com/aakloxu/chinese-copywriting-guidelines
|
||||
|
||||
## 参与英文原项目贡献
|
||||
目前我们(英文原项目)正在和 No Starch 出版社合作推出这本书。每个章节都经过[几个阶段][project]:
|
||||
|
||||
[project]: https://github.com/rust-lang/book/projects/1
|
||||
|
||||
* We write and edit a chapter's initial content
|
||||
* No Starch provides a round of edits and questions
|
||||
* We revise, clarify, and check those edits
|
||||
* A Technical Reviewer checks for the accuracy of technical details
|
||||
* No Starch copyedits the chapter for spelling, grammar, wording, consistency
|
||||
* We revise, clarify, and check the copyedits
|
||||
* The chapter goes to layout, at which point only minor changes should be made
|
||||
* 我们撰写和编辑每章的初始内容
|
||||
* No Starch 提供一轮编辑和确定问题
|
||||
* 我们修订,理清并检查这些编辑
|
||||
* 技术审查员检查技术细节的准确性
|
||||
* No Starch 对此章节审稿,排查拼写、语法、措辞和一致性问题
|
||||
* 我们再次修定,理清并检查复本
|
||||
* 此章节开始进行排版,此阶段应该只有很细微的更改
|
||||
|
||||
We would love issues and pull requests to the Markdown files in the src
|
||||
directory, up until the chapter goes to layout with No Starch. At that point,
|
||||
we will likely only be accepting changes that correct factual errors or major
|
||||
problems and not, for example, minor wording changes.
|
||||
我们欢迎大家对 src 目录的 Markdown 文件提出 issue 和 PR 合并请求,直到章节已提交给 No Starch 排版。在那个阶段后,我们很可能只接受那些错误或严重问题的修正,而不接受其他变动,如措辞上的微调。
|
||||
|
||||
The chapters we have planned but that we have not yet written appear greyed out
|
||||
in the sidebar of the rendered book. We would love issues with ideas for what,
|
||||
specifically, you'd like to see covered in those planned chapters!
|
||||
有些章节我们计划加上但未开始编写,也会出现在编译后的书籍(HTML 文档)的侧边栏。我们热烈欢迎大家对这些章节提出建议,具体来说就是,你想要看到那些计划章节中包涵哪些内容!
|
||||
|
||||
Our [open pull requests][pulls] are new chapters or edits that we're currently
|
||||
working on. We would love if you would read through those and make comments for
|
||||
any suggestions or corrections!
|
||||
我们[开放的合并请求][pulls]是针对我们正在编写的新章节或或编辑。我们也非常欢迎您阅读这些合并请求并对任意建议或更正发表评论!
|
||||
|
||||
[pulls]: https://github.com/rust-lang/book/pulls
|
||||
|
||||
If you're looking for ways to help that don't involve reading or writing, check
|
||||
out the [open issues with the E-help-wanted label][help-wanted]. These might be
|
||||
Rust code, frontend code, or shell scripts that would help us be more efficient
|
||||
or enhance the book in some way!
|
||||
如果您正在寻找不涉及阅读和写作的帮助方式,请查看[使用 E-help-wanted 标记提出问题][help-wanted]。这些可能是 Rust 代码、前端代码或 shell 脚本,这些内容将帮助我们变得更高效或以某种方式增强本书!
|
||||
|
||||
[help-wanted]: https://github.com/rust-lang/book/issues?q=is%3Aopen+is%3Aissue+label%3AE-help-wanted
|
||||
|
||||
This repository is under the same license as Rust itself, MIT/Apache2.
|
||||
本代码和文档库遵循的协议和 Rust 本身的一样,为 MIT/Apache2。
|
||||
|
@ -57,13 +57,14 @@ $ mdbook test
|
||||
|
||||
## 参与贡献
|
||||
|
||||
您的帮助,我们将感激不尽(We'd love your help)!请参见 [CONTRIBUTING.md][contrib]。
|
||||
您的帮助,我们将感激不尽(We'd love your help)!请参见 [CONTRIBUTING.md][contrib-cn](英文原项目参与贡献指引 [CONTRIBUTING-EN.md][contrib])。
|
||||
|
||||
[contrib-cn]: https://github.com/rust-lang-cn/book-cn/blob/master/CONTRIBUTING.md
|
||||
[contrib]: https://github.com/rust-lang/book/blob/master/CONTRIBUTING.md
|
||||
|
||||
## No Starch
|
||||
|
||||
> No Starch 是美国的一家出版社
|
||||
> 译注:No Starch 是美国的一家出版社
|
||||
|
||||
本书(英文原版)将由 No Starch 出版社出版,我们先在这里更新迭代,再将文本发送到 No Starch。然后他们进一步编辑,最后我们将内容取回来。
|
||||
|
||||
@ -79,7 +80,7 @@ $ mdbook test
|
||||
|
||||
## Graphviz dot
|
||||
|
||||
> Graphviz 是一种图形绘制工具,使用 dot 语言来编写绘制
|
||||
> 译注:Graphviz 是一种图形绘制工具,使用 dot 语言来编写绘制
|
||||
|
||||
这主要是给 Carol 参考的,因为她不得不检查这些内容(原文:This is mostly for Carol's reference because she keeps having to look it up)。
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user