1 Star 0 Fork 1.2K

lvxiaoqian / community

forked from openEuler / community 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
README.md 10.06 KB
一键复制 编辑 原始数据 按行查看 历史

The contenct in this folder is not finalized yet and please visit How to contribute to get help. And you are more than welcome to work with us together on updating tis folder. If you'd like to please visit community@openeuler.org.

该文档指导大家如何为openEuler社区做出贡献。欢迎阅读待解决的问题并提出新的问题。

欢迎

欢迎来到openEuler!

开始之前

签署CLA

您必须首先签署“贡献者许可协议”(CLA),然后才能参与社区贡献.

行为守则

请确保阅读并遵守openEuler社区的行为守则

社区期望

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

您的第一个贡献

随时欢迎您的加入!在社区上总是有可以改进的文档(比如您正在阅读的),可以澄清的代码,可以重构或注释的函数或变量,始终需要测试的代码。我们将帮助您了解openEuler SIG的组织方式,并引导您顺利的开始您的第一个贡献。您可以选择解决问题、编写代码,或者检视和合并等工作。所以如果您感兴趣,现在就行动吧~~

如果您对开发过程有疑问,请随时加入我们的开发邮件列表,并在邮件标题内用“【开发过程疑问】”作为标题 写出你的疑问和困惑,openEuler团队会定期扫描邮件列表上的内容,并尽力确保您的问题得到解答。

找到您感兴趣的工作

了解SIG

SIG和Repository

我们将社区按照不同的SIG来组织,以便于更好的管理和改善工作流程。

SIG组是开放的,欢迎任何人加入并参与贡献。SIG组内部会定期开会,每一个SIG都有一个公共频道。每一个SIG在Gitee上都会拥有一个或多个repository,单击SIG名称中的链接,可以获取每个SIG的README.md。在README.md里可以查找到SIG包含的子项目和子项目的额repository。

找到您感兴趣的SIG和repository

找到适合您贡献的SIG组,可以帮助您在正确的地方提出问题,为您的贡献提供更高的知名度和更快的社区响应速度。您可以查看SIG列表,以便您最快速的定位到自己感兴趣的领域。

在openEuler的Repository列表下搜索SIG名称,也可以找到对应子SIG的repository。如果搜索不到,您可以尝试在dev@openeuler.org中寻求帮助。同样,请在邮件列表内用“【开发过程疑问】”作为标题 写出你寻找的SIG或项目。

开始您的贡献

如果您的兴趣不在编写代码方面,可以在《非代码贡献指南》中找到感兴趣的工作。

给自己分配一个issue

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

提出问题

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

SIG贡献指南

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

社区贡献指导

初学者也可以通过下面的提交PR代码检视中找到相关指导。

沟通

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

Gitee工作流程

想获取要使用的代码,请参考Gitee workflow Guide

提交一个PR

openEuler遵循标准的Gitee PR请求流程,但openEuler社区还做了部分的定制,请参考openEuler社区Gitee工作流程

这两个流程的主要区别是,openEuler的机器人会将结构化标签运用于PR中。该机器人可以为您的PR过程提供一些有用的建议。为了方便查看,可以在注释中输入XXXXXXX选项,以触发自动标记和通知功能。请参阅社区命令参考文档

对于新贡献者来说,常遇到的问题是:

  • 在您的第一个PR之前没有正确的签署CLA(请参阅签署CLA
  • 为PR在SIG组内找到合适的检视者,并保证自己的贡献遵循SIG组内特定的贡献准则(请参阅了解SIG,从其中查找感兴趣的SIG提供的贡献者指导)
  • 处理在PR上失败的测试用例,这些测试用例可能与您引入的更改无关(请参阅)
  • 不遵守一些良好的编码实践
  • 在提交的信息中包含了可能关闭issue的关键字,比如XXXXXXXX等

代码检视

对于贡献者,关于代码检视的重要性的简要说明,请参阅代码检视。为了使您的提交更容易被接受,您需要:

  • 遵循SIG组的编码约定
  • 准备完善的提交信息
  • 如果一次提交的代码量较大,建议将大型的内容分解成一系列逻辑上较小的内容,分别进行提交会更便于检视者理解您的想法
  • 使用适当的SIG组和监视者标签去标记PR:机器人会发送给您消息,以方便您更好的完成整个PR的过程

对于检视者,强烈建议本着行为准则社区期望,超越自我,相互尊重和促进协作。在审查其他人的PR的时候,补丁审核的柔和艺术提出了一系列检视的重点,旨在说明检视的活动也希望能够促进新的贡献者积极参与,而不会使贡献者一开始就被细微的错误淹没,所以检视的时候,可以重点关注包括:

  • 贡献背后的想法是否合理
  • 贡献的架构是否正确
  • 贡献是否完善

注意:如果您的PR请求没有引起足够的关注,可以在XXXXX的XXXXX频道来获取查找评论者们的帮助。

测试

测试——是所有贡献者的责任,对于社区版本来说,sig-qa也会做很多的协调工作。有关的信息信息,可以参考《测试指南》

为了成功发行一个社区版本,需要完成多种测试活动。不同的测试活动,测试代码的位置也有有所不同,成功运行测试所需的环境的细节也会有差异:

todo:待qa团队补充具体的测试活动内容

  • 单元测试:这一测试活动确定特性功能的行为是否符合预期。XXXXXXXXXXXXXXXX,可以在给定包中与相应源代码的相邻位置找到单元测试的源代码。例如XXXXXXXX中定义的函数将在XXXXXXXXXX中进行单元测试。
  • XXXX测试
  • XXXX测试

持续集成会将这些测试活动在PR提交前完成,结果会出现在XXXX上

sig-qa组是负责测试活动的官方机构,他们的相关测试自动化工具在test-fra中。如果您你希望自己的基础架构上能运行XXX测试,可以考虑采用。

选择社区组件打包

请参考如何打包

安装openEuler

请参考下载安装openEuler

安全

社区文档

社区活动

交流

社区常规交流方式

大事记

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

聚会

我们遵循针对开发者的聚会的XXXXX准则,您可以通过XXXXX上的直接消息或通过电子邮件XXXX@huawei.com与XXXX联系。来加入我们把~

Go
1
https://gitee.com/lvxiaoqian/community.git
git@gitee.com:lvxiaoqian/community.git
lvxiaoqian
community
community
master

搜索帮助