docs: update submission requirement list

This commit is contained in:
yanglbme 2019-04-15 09:45:49 +08:00
parent 10e5739a70
commit a06dfc5238
2 changed files with 10 additions and 5 deletions

View File

@ -1,9 +1,9 @@
# GitHub 开发者参与专区
[Doocs/advanced-java](https://github.com/doocs/advanced-java) 欢迎各位开发朋友们分享交流自己的实践与总结,如果你想参与,请参考[提交注意事项](/docs/from-readers/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](https://github.com/doocs/advanced-java) 欢迎各位开发朋友们分享自己或他人的实践经验与总结。如果你想参与,请参考[提交注意事项](/docs/from-readers/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)。
## Articles
- [仅作示例,第一个提交的朋友请同时删除这两个示例并替换为自己的内容](/docs/from-readers/doocs-advanced-java-attention.md)
- [仅作示例,第一个提交的朋友请同时删除这两个示例并替换为自己的内容](/docs/from-readers/doocs-advanced-java-attention.md)
- [仅作示例,第一个提交的朋友请同时删除这两个示例并替换为自己的文章标题](/docs/from-readers/doocs-advanced-java-attention.md)
- [仅作示例,第一个提交的朋友请同时删除这两个示例并替换为自己的文章标题](/docs/from-readers/doocs-advanced-java-attention.md)
## Contributors
This project exists thanks to all the people who contribute.

View File

@ -1,5 +1,10 @@
# 提交注意事项
项目需要有一个统一的内容提交规范,没有规范的项目将会是一团乱麻,维护起来也会很费劲儿。以下列出了几个小点,看似很多,实则非常容易做到,供朋友们参考。
项目需要有一个统一的内容提交规范,没有规范的项目将会是一团乱麻,维护起来也会很费劲儿。以下列出了几个小点,看似很多,实际上都非常容易做到,供朋友们参考。
> 如果你有好的 idea欢迎 issues 交流。
## 关于提交形式
本项目**不希望以外链的形式引入内容**。如果你有好的内容推荐,请在此项目基本上创建新的文件,完善内容后再提交。
## 关于文件命名与存放位置
文件请以 “`GitHub ID` + 文章主题” 命名,确保每位朋友的提交内容不会冲突。文章主题统一采用**英文**命名,请勿使用中文或者汉语拼音,文件类型统一选择 `.md`
@ -23,7 +28,7 @@
```markdown
# 这是文章标题
- Author: [GitHub ID](https://github.com/your-github-id)
- Description: 文章的描述信息。
- Description: 文章的简单描述信息。
- ...
## 这是一级索引