Skip to content

Commit

Permalink
Merge pull request github#945 from lc-soft/patch-2
Browse files Browse the repository at this point in the history
Fix typo and incorrect links
  • Loading branch information
MikeMcQuaid authored Jun 20, 2019
2 parents 17fd3de + 1815a25 commit 4381bdb
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions _articles/zh-cn/building-community.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ related:

从你的文档开始:

* **让大家很容易上手。** [一份友好的 README](https://github.com/liadbiz/opensource-contribute-guide-chinise/blob/master/github-open-source-guide-02.md#编写readme)以及清晰的代码示例将让大家很容易的上手。
* **清楚的解释如何做贡献**,使用[你的CONTRIBUTING file](https://github.com/liadbiz/opensource-contribute-guide-chinise/blob/master/github-open-source-guide-02.md#编写你的贡献指南)以及持续更新issues。
* **让大家很容易上手。** [一份友好的 README](../starting-a-project/#writing-a-readme)以及清晰的代码示例将让大家很容易的上手。
* **清楚的解释如何做贡献**,使用[你的CONTRIBUTING file](../starting-a-project/#writing-your-contributing-guidelines)以及持续更新issues。

好的文档能够邀请他人参与你们项目的互动。最终,一些人会开一个issue或者pull request。将这些互动视为机会,将他们转移到漏斗的下方。

Expand Down
10 changes: 5 additions & 5 deletions _articles/zh-cn/how-to-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,12 +174,12 @@ related:

一个较大的项目,可能下面还会细分子社区,或者是针对不同的任务分成不同的小组,比如工具小组、分流、社区事务、以及活动组织等。径直到项目到 web 站点,找到"团队"页面,或者是查看治理文档,从而获得类似到信息。

靠谱的开源项目,一般都会有一个文档的,这些文档文件通常会在代码仓库的顶级目录列出。
靠谱的开源项目,一般都会有文档的,这些文档文件通常会在代码仓库的顶级目录列出。

* **许可协议:** 根据开源软件的定义,每一个开源项目必须是有[开源许可协议](https://choosealicense.com)的. 可以这么认为:假如说某个项目源码开放,但是没有任何的许可协议,那么它就不能叫做开源。
* **README:** README 是一个介绍性的说明文件,对初次光临社区对人们表示欢迎,它通常会解释项目有何用处,为何发起,以及如何快速入门等。
* **贡献:** READMES 帮助人们来认识项目,贡献这个文件则是帮助对项目如何做贡献。它解释了目前项目需要什么样类型对贡献者,社区对流程是啥样的。并非所有的项目都会有这个文件,它某种程度上也是展示项目对于贡献者的友好程度。
* **行为准则:** 顾名思义,即是一些参与社区时的一些礼仪、说话方式、行为等,帮助形成一种友好的氛围,不是所有的项目都会撰写行为准则文件,它某种程度上也是展示项目对于贡献者的友好程度。
* **LICENSE:** 根据开源软件的定义,每一个开源项目必须是有[开源许可协议](https://choosealicense.com)的. 可以这么认为:假如说某个项目源码开放,但是没有任何的许可协议,那么它就不能叫做开源。
* **README:** README 是一个介绍性的说明文件,对初次光临社区的人们表示欢迎,它通常会解释项目有何用处,为何发起,以及如何快速入门等。
* **CONTRIBUTING:** READMEs 帮助人们来认识项目,CONTRIBUTING 这个文件则是帮助对项目如何做贡献。它解释了目前项目需要什么样类型对贡献者,社区的流程是什么样的。并非所有的项目都会有这个文件,它某种程度上也是展示项目对于贡献者的友好程度。
* **CODE_OF_CONDUCT:** 顾名思义,即是一些参与社区时的一些礼仪、说话方式、行为等,帮助形成一种友好的氛围,不是所有的项目都会撰写行为准则文件,它某种程度上也是展示项目对于贡献者的友好程度。
* **其它文档:** 有些项目也许还有其它文档,例如教程、导游,或者是治理规则,这在大型项目中常见。

此外,开源项目还会利用如下一些工具来进行组织讨论,阅读这些归档对于理解社区的想法、是如何工作的有非常大的作用。
Expand Down

0 comments on commit 4381bdb

Please sign in to comment.