diff --git a/zh/Gitee-Management/Repository.md b/zh/Gitee-Management/Repository.md index e5127560f27e0813643c8be2c295bf45c7e30111..577f6a6d3484d7bcd806036a087a1d5722f103c9 100644 --- a/zh/Gitee-Management/Repository.md +++ b/zh/Gitee-Management/Repository.md @@ -161,7 +161,7 @@ maintainers: 这意味着所有这5个用户具备在`ci-bot`仓库下合入pull request的权限。 这些用户能使用`/lgtm`和`/approve`命令去触发`openeuler-ci-bot`何如pull request。 -你可以发现更多的命令说明 。 +你可以发现更多的命令说明 。 顺便说下，所有的Gitee管理员和开发者也能使用`/lgtm`和`/approve`命令。 如果你想要维护Gitee之外的仓库维护人员，请在你的仓库下添加`OWNERS`文件， diff --git a/zh/Sigs.md b/zh/Sigs.md index ee4cd84a1bf19b22372b1de32ccc134d73e2ace8..9e1bfdbec30014ea18d7c647ce77fcf419b729c5 100644 --- a/zh/Sigs.md +++ b/zh/Sigs.md @@ -15,7 +15,7 @@ IRC频道： #openeuler-doc 管理员： N/A -### sig-infra +### sig-infrastructure 基础设施建设兴趣组主要负责社区基础设施建设，包括开发系统，沟通系统等 diff --git a/zh/contributors/README.md b/zh/contributors/README.md index 886b118134fe0d61570b5acc7440a7c3ad625ca7..54c04ccb2f7e540741f8a5e2c50220472bc32aa9 100644 --- a/zh/contributors/README.md +++ b/zh/contributors/README.md @@ -38,29 +38,34 @@

开始之前

签署CLA

-您必须首先签署[“贡献者许可协议”（CLA）](/../../CLA.md)，然后才能参与社区贡献. + +您必须首先签署[“贡献者许可协议”（CLA）](./../CLA.md)，然后才能参与社区贡献.

行为守则

-请确保阅读并遵守openEuler社区的[行为守则](/../../code-of-comduct.md)。 + +请确保阅读并遵守openEuler社区的[行为守则](./../../code-of-conduct.md)。

社区期望

-openEuler是一个开源社区。因此它完全依赖于社区提供开发，以及友好和协作的环境，请查看[社区成员角色](/../community-membership.md)。社区鼓励您在积累经验的同时提高你的贡献级别。 + +openEuler是一个开源社区。因此它完全依赖于社区提供开发，以及友好和协作的环境，请查看[社区成员角色](./../../community-membership.md)。社区鼓励您在积累经验的同时提高你的贡献级别。

您的第一个贡献

+ 随时欢迎您的加入！在社区上总是有可以改进的文档（比如您正在阅读的），可以澄清的代码，可以重构或注释的函数或变量，始终需要测试的代码。我们将帮助您了解openEuler SIG/项目的组织方式，并引导您顺利的开始您的第一个贡献。您可以选择解决问题、编写代码，或者检视和合并等工作。所以如果您感兴趣，现在就行动吧~~ 如果您对开发过程有疑问，请随时加入我们的[邮件列表](dev@openeuler.org)，并在邮件标题内用“【开发过程疑问】”作为标题 写出你的疑问和困惑，openEuler团队会定期扫描邮件列表上的内容，并尽力确保您的问题得到解答。 -

找到您感兴趣的工作

+

了解SIG/项目

+ #### SIG/项目和Repository 我们将社区按照不同的SIG/项目来组织，以便于更好的管理和改善工作流程。 @@ -70,57 +75,65 @@ SIG/项目组是开放的，欢迎任何人加入并参与贡献。SIG/项目组

找到您感兴趣的SIG/项目组和repository

-找到适合您贡献的SIG/项目组，可以帮助您在正确的地方提出问题，为您的贡献提供更高的知名度和更快的社区响应速度。您可以查看[SIG/项目列表](/../SIG&project-list.md)，以便您最快速的定位到自己感兴趣的领域。 + +找到适合您贡献的SIG/项目组，可以帮助您在正确的地方提出问题，为您的贡献提供更高的知名度和更快的社区响应速度。您可以查看[SIG/项目列表](./../../SIG&project-list.md)，以便您最快速的定位到自己感兴趣的领域。 在openEuler的Repository列表下搜索SIG/项目名称，也可以找到对应子SIG/项目的repository。如果搜索不到，您可以尝试在dev@openeuler.org中寻求帮助。同样，请在邮件列表内用“【开发过程疑问】”作为标题 写出你寻找的SIG或项目。

开始您的贡献

+ 找到您感兴趣的SIG/项目的repository后，您会发现在repository内有可以拉取的代码，也有适合初学者的issue，还有交付成果的产品文档。您可以在repository中找到文档方面的改进需求，通过改进文档的过程，您也可以熟悉社区的代码提交/构建检查/合并等过程。详细可以参阅本文以了解工作流程。 -如果您的兴趣不在编写代码方面，可以在[《非代码贡献指南》](non-code-contributors.md)中找到感兴趣的工作。 +如果您的兴趣不在编写代码方面，可以在[《非代码贡献指南》](non-code-contributions.md)中找到感兴趣的工作。

给自己分配一个issue

+ 如果您愿意处理一个issue，可以将它分配给自己。只需要在评论框内输入 `/assign`或 `/assign @yourself`，机器人就会将问题分配给您，您的名字将显示在负责人列表里。

提出问题

+ 尽管社区鼓励每个人贡献代码，但是当您报告问题或缺陷的时候，也是值得赞赏的。问题应提交到对应的repository下面。您可以查看[问题提交指南](issue-submit.md)以获取更多的信息。提交问题时，请确保遵守问题提交准则。

SIG/项目贡献指南

+ 每个SIG/项目或子项目的编码语言、开发环境、编码约定等都可能是由差异的。所以每一个SIG/项目或其子项目都可能有自己的贡献者指南——一般是`CONTRIBUTING.md`文件。除了这些文件外，SIG/项目可能还会提供其他指南信息。这些信息位于SIG/项目或子项目的特定社区目录中。

社区贡献指导

-初学者也可以通过下面的[提交PR](pull-request.md)和[代码检视](expectation.md)中找到相关指导。 + +初学者也可以通过下面的[提交PR](pull-requests.md)和[代码检视](expectations.md)中找到相关指导。

沟通

+ openEuler是开源的，我们希望围绕开发建立一些半正式的管理规则，这样可以使事情开展的更加顺利。如果您认为这些规则有问题，请提出来。作为潜在的贡献者，无论是在白天、黑夜、工作日、周末或节假日，不要犹豫，我们都欢迎您提出自己的想法到dev@openeuler.org。我们致力于改善您的贡献体验。如果您发现不良的参与体验，请告诉我们！

Gitee工作流程

-想获取要使用的代码，请参考[Gitee workflow Guide](/Gitee-workflow.md)。 + +想获取要使用的代码，请参考[Gitee workflow Guide](Gitee-workflow.md)。 ### 提交一个PR -openEuler遵循标准的[Gitee PR请求流程](https://gitee.com/help/articles/4122)，但openEuler社区还做了部分的定制，请参考[openEuler社区Gitee工作流程](pull-request)。 +openEuler遵循标准的[Gitee PR请求流程](https://gitee.com/help/articles/4122)，但openEuler社区还做了部分的定制，请参考[openEuler社区Gitee工作流程](pull-requests.md)。 -这两个流程的主要区别是，openEuler的机器人会将结构化标签运用于PR中。该机器人可以为您的PR过程提供一些有用的建议。为了方便查看，可以在注释中输入XXXXXXX选项，以触发自动标记和通知功能。请参阅[社区命令参考文档](command.md)。 +这两个流程的主要区别是，openEuler的机器人会将结构化标签运用于PR中。该机器人可以为您的PR过程提供一些有用的建议。为了方便查看，可以在注释中输入XXXXXXX选项，以触发自动标记和通知功能。请参阅[社区命令参考文档](./../sig-infrastructure/command.md)。 对于新贡献者来说，常遇到的问题是： -+ 在您的第一个PR之前没有正确的签署CLA（请参阅[签署CLA](/../../CLA.md） ++ 在您的第一个PR之前没有正确的签署CLA,请参阅[签署CLA](./../CLA.md) + 为PR在SIG/项目组内找到合适的检视者，并保证自己的贡献遵循SIG/项目组内特定的贡献准则（请参阅[了解SIG/项目]()） + 处理在PR上失败的测试用例，这些测试用例可能与您引入的更改无关（请参阅） + 不遵守一些[良好的编码实践]() @@ -129,7 +142,8 @@ openEuler遵循标准的[Gitee PR请求流程](https://gitee.com/help/articles/4

代码检视

-对于贡献者，关于代码检视的重要性的简要说明，请参阅[代码检视](expectation.md)。为了使您的提交更容易被接受，您需要： + +对于贡献者，关于代码检视的重要性的简要说明，请参阅[代码检视](expectations.md)。为了使您的提交更容易被接受，您需要： + 遵循SIG/项目组的[编码约定](coding-conventions.md) + 准备完善的提交信息 @@ -149,7 +163,8 @@ openEuler遵循标准的[Gitee PR请求流程](https://gitee.com/help/articles/4

测试

-测试——是所有贡献者的责任，对于社区版本来说，sig-qa也会做很多的协调工作。有关的信息信息，可以参考[《测试指南》](/../sig-test/testing.md) + +测试——是所有贡献者的责任，对于社区版本来说，sig-qa也会做很多的协调工作。有关的信息信息，可以参考[《测试指南》](./../sig-test/testing.md) 为了成功发行一个社区版本，需要完成多种测试活动。不同的测试活动，测试代码的位置也有有所不同，成功运行测试所需的环境的细节也会有差异： @@ -166,36 +181,44 @@ todo：待qa团队补充具体的测试活动内容

选择社区组件打包

+ 请参考[如何打包](packaging.md)

安装openEuler

+ 请参考[下载安装openEuler](https://openeuler.org/zh/docs/installation/installation.html)

安全

+ + [安全发布页面]()——简要描述了处理安全问题的过程 + [安全披露信息]()——如果您希望报告安全漏洞，请参考此页面

社区文档

+ + [贡献文档]()

社区活动

+

交流

-[社区常规交流方式](/../communication) + +[社区常规交流方式](./communication)

大事记

+ openEuler参加了XXXXXX，每年在XXXXXXX，关于这些事件和其他社区事件信息可以在[openEuler事件]()页面上找到

聚会

-我们遵循针对开发者的聚会的XXXXX准则，您可以通过XXXXX上的直接消息或通过电子邮件(XXXX@huawei.com)与XXXX联系。来加入我们把~ \ No newline at end of file + +我们遵循针对开发者的聚会的XXXXX准则，您可以通过XXXXX上的直接消息或通过电子邮件与XXXX联系。来加入我们把~ \ No newline at end of file diff --git a/zh/sig-infra/label.md b/zh/sig-infra/label.md deleted file mode 100644 index 114d12ba16615f2a57c68de911cb708f4dd43e4e..0000000000000000000000000000000000000000 --- a/zh/sig-infra/label.md +++ /dev/null @@ -1,49 +0,0 @@ -## openEuler社区标签 - -openEuler社区所有的项目都有很多标签。 -这些标签给予了Issue和Pull Request某些特定的含义。 -这些标签包括： - -### CLA - -* openeuler-cla/yes -* openeuler-cla/no - -### Kind - -* kind/api-change -* kind/bug -* kind/cleanup -* kind/design -* kind/documentation -* kind/failing-test -* kind/feature -* kind/enhancement - -### Priority - -* priority/high -* priority/medium -* priority/low - -### Sig - -* sig/kernel -* sig/driver -* sig/testing -* sig/release -* sig/doc -* sig/api - -### CI - -* lgtm -* approved - -### Others - -* duplicate -* help-wanted -* invalid -* question -* wontfix diff --git a/zh/sig-infrastructure/Command.md b/zh/sig-infrastructure/Command.md deleted file mode 100644 index a673b6ed25f23dc788b4112f3d8efc3a62a1e520..0000000000000000000000000000000000000000 --- a/zh/sig-infrastructure/Command.md +++ /dev/null @@ -1,17 +0,0 @@ -# OpenEuler社区命令参考文档 - -openEuler社区的所有项目都由Bot维护。 这意味着开发人员可以在每个Pull Request或Issue下面进行回复来触发Bot命令。 这些命令包括： - -| 命令 | 示例 | 描述 | 谁能使用 | -| ------------------ | ------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | -| /check-cla | /check-cla | 强制重新检查一个Pull Request的CLA状态。 如果Pull Request的作者已经签署CLA， 这个Pull Request将会新增一个名为`openeuler-cla/yes`的标签， 反之将会新增一个名为`openeuler-cla/no`的标签。 | 任何人 | -| /lgtm [cancel] | /lgtm /lgtm cancel | 为一个Pull Request添加或者删除`lgtm`标签，这个标签将用于Pull Request合入判断。 | 这个仓库的协作者。Pull Request能使用`/lgtm cancel`命令，但是不能使用`/lgtm`命令。 | -| /approve [cancel] | /approve /approve cancel | 为一个Pull Request添加或者删除`approved`标签，这个标签将用于Pull Request合入判断。 | 这个仓库的协作者。 | -| /[remove-]kind | /kind bug /remove-kind bug | 添加或者删除这种kind类型的标签。 例如：`kind/bug`标签。 | 任何人都能在一个Pull Request或者Issue上触发这种命令。 | -| /[remove-]priority | /priority high /remove-priority high | 添加或者删除这种priority类型的标签。 例如：`priority/high`标签。 | 任何人都能在一个Pull Request或者Issue上触发这种命令。 | -| /[remove-]sig | /sig kernel /remove-sig kernel | 添加或者删除这种sig类型的标签。 例如：`sig/kernel`标签。 | 任何人都能在一个Pull Request或者Issue上触发这种命令。 | -| /close | /close | 关闭一个Pull Request或者Issue。 | 作者和仓库的协作者能触发这种命令。 | -| /reopen | /reopen | 重新打开一个Issue。 | 作者和仓库的协作者能触发这种命令。 | -| /retest | /retest | 重跑测试用例任务。 | 任何人都能在一个Pull Request上触发这种命令。 | -| /assign [[@]...] | /assign /assign @openeuler-ci-bot | 分配一个Issue给负责人。 | 任何人都能在一个Issue上触发这种命令， 但是目标负责人必须是这个组织的一个成员。 如果没有指定目标负责人，这表明这个Issue会分配给自己。 | -| /unassign [[@]...] | /unassign /unassign @openeuler-ci-bot | 取消分配一个Issue给负责人。 | 任何人都能在一个Issue上触发这种命令， 但是目标负责人必须是这个组织的一个成员。 如果没有指定目标负责人，这表明这个Issue会取消分配给自己。 | \ No newline at end of file diff --git a/zh/sig-infra/README.md b/zh/sig-infrastructure/README.md similarity index 100% rename from zh/sig-infra/README.md rename to zh/sig-infrastructure/README.md diff --git a/zh/sig-infra/Repository.md b/zh/sig-infrastructure/Repository.md similarity index 99% rename from zh/sig-infra/Repository.md rename to zh/sig-infrastructure/Repository.md index af5aa384daf165c63743c647c65974a0e39f40dd..2e208489c30f02c461480b23d7e2c9f8edcdd98d 100644 --- a/zh/sig-infra/Repository.md +++ b/zh/sig-infrastructure/Repository.md @@ -161,7 +161,7 @@ maintainers: 这意味着所有这5个用户具备在`ci-bot`仓库下合入pull request的权限。 这些用户能使用`/lgtm`和`/approve`命令去触发`openeuler-ci-bot`何如pull request。 -你可以发现更多的命令说明 。 +你可以发现更多的命令说明 。 顺便说下，所有的Gitee管理员和开发者也能使用`/lgtm`和`/approve`命令。 如果你想要维护Gitee之外的仓库维护人员，请在你的仓库下添加`OWNERS`文件， diff --git a/zh/sig-infra/command.md b/zh/sig-infrastructure/command.md similarity index 100% rename from zh/sig-infra/command.md rename to zh/sig-infrastructure/command.md diff --git a/zh/sig-infrastructure/label.md b/zh/sig-infrastructure/label.md index 59d5b1c3f4c6d632434e8170a3a59029c1aff4f8..114d12ba16615f2a57c68de911cb708f4dd43e4e 100644 --- a/zh/sig-infrastructure/label.md +++ b/zh/sig-infrastructure/label.md @@ -1,47 +1,49 @@ -# openEuler社区标签 +## openEuler社区标签 -openEuler社区所有的项目都有很多标签。 这些标签给予了Issue和Pull Request某些特定的含义。 这些标签包括： +openEuler社区所有的项目都有很多标签。 +这些标签给予了Issue和Pull Request某些特定的含义。 +这些标签包括： ### CLA -- openeuler-cla/yes -- openeuler-cla/no +* openeuler-cla/yes +* openeuler-cla/no ### Kind -- kind/api-change -- kind/bug -- kind/cleanup -- kind/design -- kind/documentation -- kind/failing-test -- kind/feature -- kind/enhancement +* kind/api-change +* kind/bug +* kind/cleanup +* kind/design +* kind/documentation +* kind/failing-test +* kind/feature +* kind/enhancement ### Priority -- priority/high -- priority/medium -- priority/low +* priority/high +* priority/medium +* priority/low ### Sig -- sig/kernel -- sig/driver -- sig/testing -- sig/release -- sig/doc -- sig/api +* sig/kernel +* sig/driver +* sig/testing +* sig/release +* sig/doc +* sig/api ### CI -- lgtm -- approved +* lgtm +* approved ### Others -- duplicate -- help-wanted -- invalid -- question -- wontfix \ No newline at end of file +* duplicate +* help-wanted +* invalid +* question +* wontfix