Skip to content

如何发表一篇文章

蔓青 edited this page Jun 6, 2018 · 13 revisions

为了方便评审,我们采用提交 pr 的方式发表文章,管理员审核通过之后会在特定的时间 merge 相关请求,文章每周一更新,请不要私自 merge

😀 为了更好的用户体验,强烈大家在发表文章之前阅读 中文文案排版指北

😀 为统一管理,文章内的相关图片请放到公用的百度云上,相关地址可咨询 @蔓青

本教程主要面向新接触 GitHub 的小伙伴们,已经熟练混于开源圈子的大佬可以略过。

1. Fork eux-blog 仓库

如果你之前有 Fork 过,请跳过这一步。并在提交之前先 同步 一下 blog 仓库。

首先需要一个 Github 账号,然后 Fork eux-blog 仓库。

2. 进入 Fork 的仓库主页

回到自己的 GitHub 主页,并找到刚刚 Fork 过的仓库,进入 eux-blog 仓库主页。例如,我的是 github.com/cyseria/eux-blog。

接下来的步骤推荐 FE/RD 使用命令行方案,UI/UE 或者想偷懒的同学可参考网页版方案。

3. 新建 branch

a. 命令行方案:

将你 Fork 之后的项目 clone 到本地,然后进入项目之后输入

git checkout -b new-arcitle

b. 使用网页版方案:

现在你需要新建一个用于新增文章的 branch,

  1. 先用鼠标左键单击 1 号位置
  2. 然后在 2 号地方填写新分支名称,比如:new-article
  3. 填写好后就会出现如 3 号所示的东西,这时用鼠标左键单击它,新 branch 就建立好了,并且现在已经自动跳转到了这个新的 branch 上。

注:新建的分支用于书写新文章和提交新文章。master 分支用于与 eux-blog 项目进行同步更新。

4. 书写 & 提交文章

文档路径信息:/doc/xx

  • 前端:FE
  • 视觉:UI
  • 交互:UE

书写的时候注意头部编写文章相关信息,例如:

---
title: "Chrome 的 First Paint"
author: "洪闰辉"
datetime: "2018-4-15"
cover: ""
---

对应字段标示:

  • title: 文章名称
  • author:作者
  • datetime: 创建文章的时间
  • cover:缩略图(图床稍后加入)

注:title 就相当于一级标题了,规范起见应避免在正文中出现 # 标题 类似的一级标题标示。

a. 已经 clone 项目到本地了的同学,直接新建文件修改文件就好

b. 使用网页版的同学书写方式:

  1. 找到对应的目录(比如 doc/fe),点击右上角的 Create new file 按钮,新建文章
  2. 书写标题内容,点击 preview 可以大概预览格式是否正确(样式与最终会有出入)

5. 提交

commit 格式尽量统一为:

[new article] 文章标题
[edit article] 文章标题: 修改信息
...

a. 采用命令行的方式

git commit -m "[new article] xxx"

b. 采用网页版:

第一步填写 Commit changes 信息并提交,初次提交时请勾选 Commit directly to the [new-arcitle] branch.,之后点击 Commit new file 按钮进行提交。

6. 发起 Pull request

进行完第 5 步的提交之后,还在这个你 Fork 的 Repo 下点击 Pull requests 按钮,然后在页面右边会出现 New pull request 按钮,并点击它。

这时会自动跳转到 eux-blog 这个 Repo 下,接下来你按照下图的解释进行操作:

  1. 显示所有的 Fork 进行对比
  2. 选择 eux-blog 的 repo 作为 base
  3. 选择自己的项目分支作为 head
  4. 点击 Create pull request 按钮并填写相关信息提交

7. 根据评审意见进行调整

自此,提交完成,这时你可以自我检查一遍,然后等待管理员进行审核,并根据评审做一定调整。