贡献与攻略
欢迎来到OpenFDE社区!
1. 体验OpenFDE
可以前往OpenFDE官网下载OpenFDE, 想要快速了解OpenFDE请前往快速入门
2. 签署CLA
在参与社区贡献前,您需要签署OpenFDE社区贡献者许可协议(CLA)。根据您的参与身份,选择签署个人CLA、员工CLA或者企业CLA,请点击这里前往签署。
3. 参与OpenFDE社区
3.1 参与社区活动
更多社区活动正在筹备中.....敬请期待!! 待补充测评活动详情
3.2 参与社区贡献
3.2.1 提交issue/处理issue任务
您可以点击问题反馈,进入OpenFDE的问题反馈仓库。
提交issue:点击"新建Issue"按钮,就可以新建Issue,记录你想提出的问题。
处理issue:如果您愿意处理其中的一个issue,可以将issue分配给自己,将自己设置为负责人。
参与issue内的讨论:每个issue下面可能已经有参与者们的讨论和交流,如果您感兴趣,也可以在评论框中发表自己的意见。
3.2.2 贡献编码
准备OpenFDE的开发环境
如果您想参与编码贡献,需要准备OpenFDE的开发环境,请参考快速开始(AOSP编译)
下载代码和拉取分支
如果想要参与代码贡献,您还需要了解如何在Gitee下载代码、通过PR合并代码等。OpenFDE使用的是Gitee代码托管平台,想了解具体的指导,请参考Gitee Workflow Guide.该托管平台的使用方式和GitHub类似,如果您以前使用过GitHub,本节的内容您可以大致了解甚至跳过。
修改、构建和本地验证
在本地分支上完成修改后,进行构建和本地验证。
提交一个Pull-Request
当你提交一个PR的时候,就意味着您已经开始给社区贡献代码了。
3.2.3 贡献软件包
如果您发现OpenFDE缺失了一个软件包,可以帮OpenFDE把这个软件包补上。实际上贡献软件包的过程就是版主OpenFDE提供更丰富功能的过程。
OpenFDE支持在Gitee新增软件包的同时自动在obs的OpenFDE:Factory上创建同名仓库,这样在向已创建的Gitee仓库提交代码时,会自动对代码编译进行检测。
3.2.4 贡献原创开源项目
如果你想将自己原创的开源项目贡献到OpenFDE社区,成为OpenFDE发行版本的一份子,那么可参考以下几种方式:
方式一: 在其他社区开发,集成到OpenFDE中,将软件加入到OpenFDE的repo仓即可。
方式二: 在OpenFDE社区中开发,【方式待定】
3.2.5 检视代码
OpenFDE是一个开放的社区,我们希望所有参与社区的人都能成为活跃的检视者。
对于贡献者,为了使您的代码更容易被接受,您需要:
准备完善的提交信息
如果一次提交的代码量较大,建议将大型的内容分解为一系列逻辑上较小的内容,分别进行提交会更便于检视者理解您的逻辑
对于检视者,强烈建议本着社区行为守则 ,超越自我,相互尊重和促进协作。检视的重点可以参考补丁审核的柔和艺术。检视的时候,可以重点关注包括:
贡献背后的想法是否合理
贡献的架构是否正确
贡献是否完善
3.2.6 测试
测试是所有贡献者的责任,详细攻略请参考(待更新补充【测试贡献指南】)
3.2.7 文档贡献
你可以向本社区贡献你的技术文章,前往OpenFDE博客页面 发表你的博客
3.2.8 选择社区组件打包
您也可以参与社区组件打包,打包教程待更新。