From dbb07e8aaad7f02740fe950c1c67ac7257c1c0ae Mon Sep 17 00:00:00 2001 From: yanglbme Date: Sat, 13 Apr 2019 17:10:46 +0800 Subject: [PATCH] docs(from-readers): update doocs-advanced-java-attention.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 更新文章注意事项。 --- docs/from-readers/README.md | 14 ++++++++++--- .../doocs-advanced-java-attention.md | 21 ++++++++++++++++++- 2 files changed, 31 insertions(+), 4 deletions(-) diff --git a/docs/from-readers/README.md b/docs/from-readers/README.md index 2066156..bbdc489 100644 --- a/docs/from-readers/README.md +++ b/docs/from-readers/README.md @@ -1,6 +1,14 @@ # 读者分享专区 -本项目欢迎朋友们分享交流自己的实践与总结，如果你想参与，请注意参考[提交注意事项](./doocs-advanced-java-attention.md)。感谢 [@jerryldh](https://github.com/jerryldh), [@BigBlackSheep](https://github.com/BigBlackSheep), [@sunyuanpinggithub](https://github.com/sunyuanpinggithub) 等多位读者的反馈，具体请参考 #46。 +本项目欢迎朋友们分享交流自己的实践与总结，如果你想参与，请参考[提交注意事项](./doocs-advanced-java-attention.md)。感谢 [@jerryldh](https://github.com/jerryldh), [@BigBlackSheep](https://github.com/BigBlackSheep), [@sunyuanpinggithub](https://github.com/sunyuanpinggithub) 等多位读者的反馈，具体请参考 [#46](https://github.com/doocs/advanced-java/issues/46)。 -## 分享列表 +## 文章列表 - [仅作示例，第一个提交的朋友请同时删除这两个示例并替换为自己的内容](./doocs-advanced-java-attention.md) -- [仅作示例，第一个提交的朋友请同时删除这两个示例并替换为自己的内容](./doocs-advanced-java-attention.md) \ No newline at end of file +- [仅作示例，第一个提交的朋友请同时删除这两个示例并替换为自己的内容](./doocs-advanced-java-attention.md) + +## Contributors +下面图片仅作占位符，待替换。 + + +|
[](https://github.com/yanglbme)
| | | | | | | | +|---|---|---|---|---|---|---|---| + \ No newline at end of file diff --git a/docs/from-readers/doocs-advanced-java-attention.md b/docs/from-readers/doocs-advanced-java-attention.md index 6804384..38f13cb 100644 --- a/docs/from-readers/doocs-advanced-java-attention.md +++ b/docs/from-readers/doocs-advanced-java-attention.md @@ -14,6 +14,25 @@ ## 关于文章排版 请注意文章排版的美观性。中英文之间、中文与数字之间用空格隔开是最基本的。图片统一使用 `![](/images/icon.png)` 进行相对引用，并同时存放于根目录 `images` 和本专区目录 `from-readers/images` **两个位置**（这是为了在 GitHub 和 GitHub Page 都能正常显示图片）。具体文章书写规范请参考《[中文技术文档的写作规范](https://github.com/ruanyf/document-style-guide)》 +以下是基本文章结构参考。 + +```markdown +# 这是文章标题 +- Author: [GitHub ID](https://github.com/your-github-id) +- Description: 文章的描述信息。 +- ... + +## 这是一级索引 +... +### 这是二级索引 +... + +## 这是一级索引 +... +### 这是二级索引 +... +``` + ## 关于 Git 提交信息 Git 提交信息统一使用英文，本项目遵从 Angular JS Git 提交规范。e.g. @@ -21,4 +40,4 @@ Git 提交信息统一使用英文，本项目遵从 Angular JS Git 提交规范 git commit -m "docs(from-readers): add an article about Kafka" ``` -Git 提交不规范的文章将不予采纳。 \ No newline at end of file +Git 提交信息不规范的 PR 将不予合并。 \ No newline at end of file