File tree 1 file changed +4
-5
lines changed
1 file changed +4
-5
lines changed Original file line number Diff line number Diff line change 1
1
# 讲解开源项目创作须知
2
2
3
- ** 大家都是不同技术领域的先行者了** ,我只是这个方案的发起者并并不是完全的掌舵者 。我只希望大家既然上了 HelloGitHub 这艘船,那么我们就一起** 开心并努力地** 走走看,看看未知海域到底是什么样!
3
+ ** 大家都是不同技术领域的先行者了** ,我只是这个方案的发起者并不是完全的掌舵者 。我只希望大家既然上了 HelloGitHub 这艘船,那么我们就一起** 开心并努力地** 走走看,看看未知海域到底是什么样!
4
4
5
5
## 一、创作的基本流程
6
6
1 . 选取文章面向的人群
20
20
3 . 在 https://hellogithub.com/ 按照语言分类, 挑选合适的项目(当然,这不是必须的。未收录进 HG 的项目也可以)
21
21
22
22
### 1.3 内容结构
23
- 1 . 项目介绍:这是个什么东西,解决了那些场景下的痛点 ,使用这个库带来的好处
23
+ 1 . 项目介绍:这是个什么东西,解决了哪些场景下的痛点 ,使用这个库带来的好处
24
24
2 . 快速开始:安装、主要 API 介绍、架构介绍、项目的大体结构
25
25
3 . 亮点、缺点、坑、相关资料介绍
26
26
34
34
2 . 文章遵循 [ ** Markdown** ** 语法** ] ( https://github.com/younghz/Markdown ) 。
35
35
3 . 风格遵循 [ ** 中文文案排版指北** ] ( https://github.com/sparanoid/chinese-copywriting-guidelines )
36
36
37
- > Tip : (避免走弯路)
37
+ > Tips : (避免走弯路)
38
38
> 1 . 图文、代码并茂,这样会让文章增色不少。
39
39
> 2 . 提交文章之前一定要使用 [ lint-md 工具] ( https://github.com/hustcc/lint-md/tree/master/packages/lint-md-cli ) 检查 Markdown 格式
40
40
> 3 . 禁止使用非标准 Markdown 语法,不支持 GFM 等扩展语法和 LaTeX 公式。
44
44
## 三、创作流程
45
45
46
46
1 . 作者前期构思文章的选材后告知我,我们共同确认后再开始创作。
47
- > 注: 如果讲解的开源三方库 ,讲解的项目并非为 HelloGitHub 之前收录的文章,需要提前告知我。
47
+ > 注: 如果讲解的开源第三方库 ,讲解的项目并非为 HelloGitHub 之前收录的文章,需要提前告知我。
48
48
2 . 确定文章和选材后约定提交文章时间,提交地址:https://github.com/HelloGitHub-Team/Article
49
49
3 . 文章提交后,我会做内容审核和文章排版修改(不失文章本意、不夸张),并发布公众号文章预览,作者审核通过、同意后。我会告知文章最终的发布时间,并同步到 HG 全平台的账号下。
50
50
4 . 反馈各平台发布情况和链接
56
56
3 . 文章的提交时间,依照作者的时间安排。但是** 约定的交稿时间一定要交付** ,如期间遇到无法交稿的情况可提前告知,没有关系。
57
57
4 . 文章对应的配图,需要创建对应的目录并标记对应的图片编号。如第一张图片:1.png/jpeg/gif
58
58
5 . 如需标明作者,请告知我。将在文章开头标记为:HelloGitHub-Team —— xxx,如无需则作者统一为:HelloGitHub
59
- 6 . ** 文章打赏如果低于 100 元全部归作者所有,大于或等于 100 元 HG 收取 15%** 。
60
59
61
60
62
61
## 四、联系方式
You can’t perform that action at this time.
0 commit comments