Skip to content

Commit

Permalink
Merge pull request #23 from landylee007/main
Browse files Browse the repository at this point in the history
docs update
  • Loading branch information
landylee007 authored May 23, 2021
2 parents 62a36b8 + 51e3665 commit 6eb1264
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING-zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ Zadig 的成长离不开大家的支持。我们欢迎各类贡献,小到修

## 环境设置

请先fork一份对应的仓库,不要直接在仓库下建分支。然后可以参考 [Zadig 开发流程](community/dev/contributor-workflow.md) 的介绍将 Zadig 环境搭建起来。
请先 fork 一份对应的仓库,不要直接在仓库下建分支。然后可以参考 [Zadig 开发流程](community/dev/contributor-workflow.md) 的介绍将 Zadig 环境搭建起来。

在决定提交issue或者提交任何更改之前,请查一下项目的 [open issues](https://github.com/koderover/Zadig/issues),避免重复。我们也准备
在决定提交 issue 或者提交任何更改之前,请查一下项目的 [open issues](https://github.com/koderover/Zadig/issues),避免重复。我们也准备
了几个 issue label 来帮助大家筛选:

1) 如果你想找一些适合上手的 issue,可以看下 [#good-first-issue](https://github.com/koderover/Zadig/labels/good%20first%20issue)
Expand All @@ -57,9 +57,9 @@ Zadig 的成长离不开大家的支持。我们欢迎各类贡献,小到修
4. [`question`](https://github.com/koderover/Zadig/labels/question)
5. [`enhancement`](https://github.com/koderover/Zadig/labels/enhancement)

如果贡献者知道自己的issue是明确关于哪个或者哪几个服务的,也建议将服务相对应的label加上去:具体请[搜索我们带`service/`前缀的 label](https://github.com/koderover/Zadig/labels?q=service%2F);如果不确定的话可以放着,我们的 maintainer 会加上。
如果贡献者知道自己的 issue 是明确关于哪个或者哪几个服务的,也建议将服务相对应的 label 加上去:具体请[搜索我们带`service/`前缀的 label](https://github.com/koderover/Zadig/labels?q=service%2F);如果不确定的话可以放着,我们的 maintainer 会加上。

请首先检查下我们的 [open issues](https://github.com/koderover/Zadig/issues),确保不要提交重复的 issue。确认没有重复后,请选择上面四种类型之一的 label并且按 issue 模板填好,尽可能详细的解释你的 issue —— 原则是要让没有你 context 的别人也能很容易的看懂。
请首先检查下我们的 [open issues](https://github.com/koderover/Zadig/issues),确保不要提交重复的 issue。确认没有重复后,请选择上面类型之一的 label并且按 issue 模板填好,尽可能详细的解释你的 issue —— 原则是要让没有你 context 的别人也能很容易的看懂。

### Issue 提交后会被如何处理?

Expand All @@ -68,7 +68,7 @@ Zadig 的成长离不开大家的支持。我们欢迎各类贡献,小到修
1. 他们会再次确认新创建的 issue 是不是添加了上述五种 label 里正确的 label,如果不是的话他们会进行更新。
2. 他们同时也会决定是不是 accept issue,参见下一条。
3. 如果适用的话,他们可能会将以下四种新的 tag 加到 issue 上:
1) [`duplicate`](https://github.com/koderover/Zadig/labels/duplicate): 重复的issue
1) [`duplicate`](https://github.com/koderover/Zadig/labels/duplicate): 重复的 issue
2) [`wonfix`](https://github.com/koderover/Zadig/labels/wontfix):决定不采取行动。maintainer 会说明不修复的具体原因,比如
work as intended, obsolete, infeasible, out of scope
3) [`good first issue`](https://github.com/koderover/Zadig/labels/good%20first%20issue):见上文,适合新人上手的 issue。
Expand All @@ -92,7 +92,7 @@ Zadig 的成长离不开大家的支持。我们欢迎各类贡献,小到修

对于**任何**的代码改动,你**都需要有相应的 issue 来跟踪**:不管是现有的 issue 还是[创建一个新的 issue](#贡献方式-1---提交-issue)

> 请在对应的issue下留言,表明你要WORK ON这个issue,避免重复
> 请在对应的 issue 下留言,表明你要 WORK ON 这个 issue,避免重复
### 简单的代码改动

Expand Down
3 changes: 2 additions & 1 deletion README-zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
[![Zadig CI](https://os.koderover.com/api/collie/api/badge?pipelineName=zadig-ci/zadig-ci&source=github&repoFullName=koderover/Zadig&branch=main&eventType=push)](https://os.koderover.com/v1/projects/detail/zadig-ci/pipelines/freestyle/home/zadig-ci/608824fef341de000137317d?rightbar=step)
[![LICENSE](https://img.shields.io/github/license/koderover/zadig.svg)](https://github.com/koderover/zadig/blob/main/LICENSE)
[![Language](https://img.shields.io/badge/Language-Go-blue.svg)](https://golang.org/)
![GitHub all releases](https://img.shields.io/github/downloads/koderover/Zadig/total)
[![Go Report Card](https://goreportcard.com/badge/github.com/koderover/zadig)](https://goreportcard.com/report/github.com/koderover/zadig)
![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/koderover/zadig?include_prereleases)

</span>

Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
[![Zadig CI](https://os.koderover.com/api/collie/api/badge?pipelineName=zadig-ci/zadig-ci&source=github&repoFullName=koderover/Zadig&branch=main&eventType=push)](https://os.koderover.com/v1/projects/detail/zadig-ci/pipelines/freestyle/home/zadig-ci/608824fef341de000137317d?rightbar=step)
[![LICENSE](https://img.shields.io/github/license/koderover/zadig.svg)](https://github.com/koderover/zadig/blob/main/LICENSE)
[![Language](https://img.shields.io/badge/Language-Go-blue.svg)](https://golang.org/)
![GitHub all releases](https://img.shields.io/github/downloads/koderover/Zadig/total)
[![Go Report Card](https://goreportcard.com/badge/github.com/koderover/zadig)](https://goreportcard.com/report/github.com/koderover/zadig)
![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/koderover/zadig?include_prereleases)

</span>

Expand Down

0 comments on commit 6eb1264

Please sign in to comment.