From fa2e534e62669001779543fb5e6a3984554b1ba7 Mon Sep 17 00:00:00 2001 From: sjfkai Date: Wed, 2 Mar 2016 15:35:49 +0800 Subject: [PATCH] follow up updates --- CONTRIBUTING_zh_CN.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING_zh_CN.md b/CONTRIBUTING_zh_CN.md index 4dbf3f2a..3dd1e78f 100644 --- a/CONTRIBUTING_zh_CN.md +++ b/CONTRIBUTING_zh_CN.md @@ -2,9 +2,16 @@ 将小知识提交到本列表,`fork`此仓库(repository)然后将的小知识放到对应文件夹(根据语言)的新文件中。新文件的名字应该像`2016-xx-xx-name-of-your-tip`这样。 -书写小知识时请按照[这个格式](https://github.com/loverajoel/jstips/blob/gh-pages/POST_TEMPLATE.md)。你的小知识应该能够让读者在两分钟内读懂。如果愿意你可以添加其他网站或视频的链接来提供更多内容。 +书写小知识时请按照[这个格式](https://github.com/loverajoel/jstips/blob/gh-pages/POST_TEMPLATE.md)。 -当你的小知识准备就绪了, 根据这个[PR 模板](https://github.com/loverajoel/jstips/blob/gh-pages/GIT_TEMPLATE.md),[发布一个pull request](https://help.github.com/articles/using-pull-requests/)你的小知识将被审查(review)。每天都会有一条小知识从可用的pull requests中merge到本仓库。 +### 要求 +- 小知识可以在两分钟内阅读完。 +- 增加其他网站或视频的链接提供更深讲解更佳 +- 使用 ```js 标记JS代码 +- 无序在标题处提及"JavaScript"(因为我们的小知识全是关于它的) +- 使用反引号(`) 标记标题中的代码 ‐ _警告_:标题不能以反引号开头 + +当你的小知识准备就绪了, 根据这个[PR 模板](https://github.com/loverajoel/jstips/blob/gh-pages/GIT_TEMPLATE.md),[发布一个pull request](https://help.github.com/articles/using-pull-requests/)你的小知识将被审查(见下文)。 # 提示 @@ -12,7 +19,9 @@ # 工作流程 -**Tip 提交** -> **Tip 审查** -> **Tip 通过并发布** +**Tip 提交** ⇒ **Tip 审查** ⇒ **Tip 通过并发布** + +- 当你提交 tip 时,如果 tip 正在通过审查,此时 tip 状态为 `under review`。 +- 如果 tip 经过5个人的审查,而且他們都给了 :shipit:,tip 将会被合并(`merge`)到 tip 列表中。 -- 当你提交 tip 时,如果 tip 正在通过审查,此时 tip 状态为 `under-review`。 -- 如果 tip 经过5个人的审查,而且他們都给了 :shipit:,tip 将会被合并(`merge`)到 tip 列表中。 \ No newline at end of file +期待您的贡献! \ No newline at end of file