Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2017.12.3 A组输出评审记录 #7

Open
lzufalcon opened this issue Dec 3, 2017 · 2 comments
Open

2017.12.3 A组输出评审记录 #7

lzufalcon opened this issue Dec 3, 2017 · 2 comments

Comments

@lzufalcon
Copy link
Contributor

lzufalcon commented Dec 3, 2017

  1. 提交的 PR 要尽可能简洁

    本地修改记录需要合并整理。如果改动单一,可以重新基于远程仓库提交新的commit,把改动文件加入。

  2. 文档中尽量只保留内容本身

    为了方便评审以及以后的出版需要,不要引入不必要的 html 格式,尽可能做到内容和格式分离,文档只以最简洁的 markdown 语法呈现,我们的精力也更聚焦内容本身。

  3. 中英文排版尽量多留白,就是英文或者数字前后在必要的时候留空格

    当然,当英文前后为符号或者前后没有其他内容时,空格是不需要的,例如,英文出现在行首,或者前后是一个逗号,诸如此类。

  4. 引用的内容务必注明出处,可以用脚注或者链接

    脚注的语法类似:

     hello[^hello]
    
     [^hello]: hi
    
  5. 内容需要有更多的整合和升华

    整合意味着更多素材和书籍的阅读以及精华萃取,升华意味着深度和广度的覆盖。

    比如说历史部分,我们可以适当增加 1.0 版本之后一些历史大版本的信息,可参考 https://en.wikipedia.org/wiki/History_of_Linuxhttps://kernelnewbies.org/LinuxVersions

    也可以适当增加,比如说历史上各个时期的发布节奏,代码和补丁的版本管理工具,协作方式,这些可以让整个内容更充盈起来。

@shipujin
Copy link
Member

shipujin commented Dec 3, 2017

OK

@lzufalcon
Copy link
Contributor Author

@lina-not-linus @bjwrkj 追加一条规则:

  1. 行末的空格要去掉,用法:

    %s#[[:space:]]*$#g

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants