diff --git a/README.md b/README.md index a84c03e..2b72ecb 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [](https://github.com/doocs/intro) [](https://github.com/doocs/technical-books) [](https://github.com/doocs/leetcode) -[](https://github.com/doocs/advanced-java/blob/master/docs/from-readers/README.md) +[](https://github.com/doocs/advanced-java/blob/master/docs/from-readers/README.md) [](https://github.com/doocs/advanced-java/stargazers) [](https://github.com/doocs/advanced-java/network/members) [](https://github.com/doocs/advanced-java/tree/master/docs/from-readers#contributors) diff --git a/docs/from-readers/README.md b/docs/from-readers/README.md index b3983d7..a83f7c1 100644 --- a/docs/from-readers/README.md +++ b/docs/from-readers/README.md @@ -6,6 +6,8 @@ - [仅作示例，第一个提交的朋友请同时删除这两个示例并替换为自己的内容](/docs/from-readers/doocs-advanced-java-attention.md) ## Contributors +This project exists thanks to all the people who contribute. + <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | <center> [<img src="https://avatars3.githubusercontent.com/u/21008209?v=4" width="80px;"/>](https://github.com/yanglbme) </center> | <center> [<img src="https://avatars3.githubusercontent.com/u/31427850?v=4" width="80px;"/>](https://github.com/ImgBotApp) </center> | <center> [<img src="https://avatars3.githubusercontent.com/u/14137033?v=4" width="80px;"/>](https://github.com/lianghao208) </center> | <center> [<img src="https://avatars3.githubusercontent.com/u/5753574?v=4" width="80px;"/>](https://github.com/tccbest) </center> | <center> [<img src="https://avatars3.githubusercontent.com/u/15058152?v=4" width="80px;"/>](https://github.com/sheldonyss) </center> | <center> [<img src="https://avatars3.githubusercontent.com/u/44314231?v=4" width="80px;"/>](https://github.com/igayhub) </center> | <center> [<img src="https://avatars3.githubusercontent.com/u/25682169?v=4" width="80px;"/>](https://github.com/naah69) </center> | | diff --git a/docs/from-readers/doocs-advanced-java-attention.md b/docs/from-readers/doocs-advanced-java-attention.md index 38f13cb..3a7c6e6 100644 --- a/docs/from-readers/doocs-advanced-java-attention.md +++ b/docs/from-readers/doocs-advanced-java-attention.md @@ -1,20 +1,22 @@ # 提交注意事项 +项目需要有一个统一的内容提交规范，没有规范的项目将会是一团乱麻，维护起来也会很费劲儿。以下列出了几个小点，看似很多，实则非常容易做到，供朋友们参考。 + ## 关于文件命名 -为了让文件名具备唯一性，文件请以 “`GitHub ID` + 主题” 命名。 +文件请以 “`GitHub ID` + 文章主题” 命名，确保每位朋友的提交内容不会冲突。文章主题统一采用**英文**命名，请勿使用中文或者中式英语，文件类型统一选择 `.md`。**文件命名不规范的文章将不予采纳**。 -文章主题统一采用英文命名，请勿使用中文或者中式英语，文件类型统一 `.md`。 - -比如，我的 GitHub ID 是 yanglbme，想分享一篇关于 Kafka 实践相关的文章，文件名可以是 `yanglbme-kafka-in-action.md`。 - -**文件命名不规范的文章将不予采纳**。 +给个示例。某位朋友的 GitHub ID 是 [SnailClimb](https://github.com/snailclimb)，想分享一篇关于 Kafka 实践相关的文章，那么文件名可以是 `snailclimb-kafka-in-action.md`。 ## 关于文章内容 -请分享与此项目主题相关的文章，比如：高并发、分布式、高可用、微服务等相关领域的内容。**其它主题的文章将不会被采纳**。 +仅收录与此项目主题相关的优质文章，可以是[高并发](https://github.com/doocs/advanced-java#高并发架构)、[分布式](https://github.com/doocs/advanced-java#分布式系统)、[高可用](https://github.com/doocs/advanced-java#高可用架构)、[微服务](https://github.com/doocs/advanced-java#高并发架构微服务架构)等相关领域的内容。**其它主题的文章将不会被采纳**。 ## 关于文章排版 -请注意文章排版的美观性。中英文之间、中文与数字之间用空格隔开是最基本的。图片统一使用 `` 进行相对引用，并同时存放于根目录 `images` 和本专区目录 `from-readers/images` **两个位置**（这是为了在 GitHub 和 GitHub Page 都能正常显示图片）。具体文章书写规范请参考《[中文技术文档的写作规范](https://github.com/ruanyf/document-style-guide)》 +文章排版保持整洁美观。中英文之间、中文与数字之间用空格隔开是最基本的。 -以下是基本文章结构参考。 +> 有研究显示，打字的时候不喜欢在中文和英文之间加空格的人，感情路都走得很辛苦，有七成的比例会在 34 岁的时候跟自己不爱的人结婚，而其余三成的人最后只能把遗产留给自己的猫。毕竟爱情跟书写都需要适时地留白。 + +图片统一使用 `` 进行相对引用，并同时存放于根目录 `images` 和本专区目录 `from-readers/images` **两个位置**（这是为了在 GitHub 和 GitHub Page 都能正常显示图片；图片并不限定 `png` 格式），作图推荐使用在线工具 [ProcessOn](https://www.processon.com/i/594a16f7e4b0e1bb14fe2fac)。具体文章书写规范请参考《[中文技术文档的写作规范](https://github.com/ruanyf/document-style-guide)》。 + +以下是文章基本的结构，供朋友们参考。 ```markdown # 这是文章标题 @@ -34,7 +36,7 @@ ``` ## 关于 Git 提交信息 -Git 提交信息统一使用英文，本项目遵从 Angular JS Git 提交规范。e.g. +Git 提交信息统一使用英文，本项目遵从 [Angular JS Git 提交规范](https://github.com/angular/angular.js/commits/master)。e.g. ```bash git commit -m "docs(from-readers): add an article about Kafka"