From 11e968a03aaecbb65ae80dde56c2a3782b44b973 Mon Sep 17 00:00:00 2001 From: Jerry Lee Date: Wed, 28 Oct 2015 21:06:10 +0800 Subject: [PATCH] add CONTRIBUTING.md #14 --- CONTRIBUTING.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..44c1466 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,77 @@ +欢迎贡献 +==================== + +- :see_no_evil: [自己](http://weibo.com/oldratlee)理解粗浅,翻译中不足和不对之处,欢迎 :clap: + - 建议,[提交`Issue`](https://github.com/oldratlee/translations/issues/new) + - 指正,[`Fork`后提通过`Pull Requst`贡献修改](https://github.com/oldratlee/translations/fork) +- 如有文章理解上有疑问 或是 使用过程中碰到些疑惑,请随意:raised_hands:[提交`Issue`](https://github.com/oldratlee/translations/issues/new) ,一起学习交流讨论! + +贡献你的修改请注意 +----------------- + +好的排版可以突出重点,也方便阅读/编辑。 + +### 对于英文术语,请用代码块引用 + +格式:\`Unix\`,效果:`Unix`。 +这样的等宽样式即可以突出术语重点,也过很优美。 + +### 自成一段的代码,要加上代码语法染色 + +语法染色方便阅读。 + +格式: + + ```c + #include + + int main(int argc, char *argv[]) + { + puts("Hello World"); + return 0; + } + ``` + +效果: + +```c +#include + +int main(int argc, char *argv[]) +{ + puts("Hello World"); + return 0; +} +``` + +### 一号/二号标题使用下划风格 + +方便编辑时迅速识别。 + +格式: + + HEAD 1 + ===================== + + HEAD 2 + --------------------- + +### 对于过长行,请换行 + +这样方便编辑。 + + “For a long time it puzzled me how something so expensive, so leading edge, could be so useless. + And then it occurred to me that a computer is a stupid machine with the ability to do incredibly smart things, + while computer programmers are smart people with the ability to do incredibly stupid things. + They are, in short, a perfect match.” + + — Bill Bryson + +因为在`Markdown`换行是不分段的(通过空行分段),所以不影响显示效果。上面内容显示效果如下: + +“For a long time it puzzled me how something so expensive, so leading edge, could be so useless. +And then it occurred to me that a computer is a stupid machine with the ability to do incredibly smart things, +while computer programmers are smart people with the ability to do incredibly stupid things. +They are, in short, a perfect match.” + +— Bill Bryson