Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 3.32 KB

创作须知.md

File metadata and controls

65 lines (47 loc) · 3.32 KB
Raw

讲解开源项目创作须知

大家都是不同技术领域的先行者了，我只是这个方案的发起者并不是完全的掌舵者。我只希望大家既然上了 HelloGitHub 这艘船，那么我们就一起开心并努力地走走看，看看未知海域到底是什么样！

一、创作的基本流程

  1. 选取文章面向的人群
  2. 对文章进行选题
  3. 内容结构
  4. 提交

1.1 读者人群介绍

  1. 对开源感兴趣的人群
  2. 有一定的编程基础（不同编程语言）
  3. 喜欢尝试新鲜项目的人群
  4. 学完某种语言后迷茫不知道做什么的人群

1.2 文章取材方向

  1. 自己写项目;
  2. 在 Github 自行发掘好的项目;
  3. 在 https://hellogithub.com/ 按照语言分类, 挑选合适的项目（当然，这不是必须的。未收录进 HG 的项目也可以）

1.3 内容结构

  1. 项目介绍：这是个什么东西，解决了哪些场景下的痛点，使用这个库带来的好处
  2. 快速开始：安装、主要 API 介绍、架构介绍、项目的大体结构
  3. 亮点、缺点、坑、相关资料介绍

二、文章规范

就像团队开发一样，写代码也一定要规范！

  1. 所有的文章均采用 Markdown 编写
  2. 文章遵循 Markdown 语法。
  3. 风格遵循 中文文案排版指北

Tips: （避免走弯路）

  1. 图文、代码并茂，这样会让文章增色不少。
  2. 提交文章之前一定要使用 lint-md 工具 检查 Markdown 格式
  3. 禁止使用非标准 Markdown 语法，不支持 GFM 等扩展语法和 LaTeX 公式。
  4. 仔细阅读 中文文案排版指北，避免后期发布文章时，整改麻烦。

三、创作流程

  1. 作者前期构思文章的选材后告知我，我们共同确认后再开始创作。

注: 如果讲解的开源第三方库，讲解的项目并非为 HelloGitHub 之前收录的文章，需要提前告知我。

  1. 确定文章和选材后约定提交文章时间，提交地址：https://github.com/HelloGitHub-Team/Article
  2. 文章提交后，我会做内容审核和文章排版修改（不失文章本意、不夸张），并发布公众号文章预览，作者审核通过、同意后。我会告知文章最终的发布时间，并同步到 HG 全平台的账号下。
  3. 反馈各平台发布情况和链接

上述流程中的细节问题：

  1. 未避免全盘皆输，上述所有阶段都可以与我沟通：构思、选材、初稿等
  2. 第三方开源库讲解，可以是自己的项目
  3. 文章的提交时间，依照作者的时间安排。但是约定的交稿时间一定要交付，如期间遇到无法交稿的情况可提前告知，没有关系。
  4. 文章对应的配图，需要创建对应的目录并标记对应的图片编号。如第一张图片：1.png/jpeg/gif
  5. 如需标明作者，请告知我。将在文章开头标记为：HelloGitHub-Team —— xxx，如无需则作者统一为：HelloGitHub

四、联系方式

阅读完上述须知，如果有兴趣加入，就可以通过下面的方式联系我：