openEuler驱动开发规范

目的

为规范和统一 openEuler 驱动开发的提交流程及方式,使驱动在 openEuler上使能,特制定 openEuler 驱动开发规范。

适用范围

openEuler 驱动开发规范适用于 openEuler 在开发以及已发布的所有版本的开发过程。

包括但不限于以下版本:

  • openEuler 20.03 LTS SP3
  • openEuler 22.03 LTS
  • openEuler 22.03 LTS SP1

对驱动的基本要求

openEuler的目标:

  • 成为技术创新的平台,加速技术创新、成熟及落地应用。
  • 维护安全稳定、可靠、性能领先以及生态丰富的稳定内核,方便产业界快速应用。

因此,满足以上原则的驱动可以提交至openEuler。

签署贡献者协议 (CLA)

贡献者贡献openEuler社区前,需签署贡献者协议CLA

说明 :CLA签署后大约需要一周时间生效。

驱动要求

驱动需满足如下要求:

  1. 名称不能与系统已有名称发生冲突。
  2. 对照openEuler社区KABI检测。
  3. 正确的驱动版本信息。
  4. 驱动模块参数需要解释说明。
  5. 如有配套工具一并提供。
  6. 声明 license 信息。
  7. 建议增加驱动与操作系统发行版耦合方式的规范,如直接检查 /etc/openEuler-release 文件或者其它作为技术路线的判断,不再与具体的发行版信息耦合。
  8. 在社区建仓开发时同步提供驱动安装指导。

参考资料

文档捉虫

“有虫”文档片段

问题描述

提交类型 issue
有点复杂...
找人问问吧。
PR
小问题,全程线上修改...
一键搞定!
问题类型
规范和低错类

● 错别字或拼写错误;标点符号使用错误;

● 链接错误、空单元格、格式错误;

● 英文中包含中文字符;

● 界面和描述不一致,但不影响操作;

● 表述不通顺,但不影响理解;

● 版本号不匹配:如软件包名称、界面版本号;

易用性

● 关键步骤错误或缺失,无法指导用户完成任务;

● 缺少必要的前提条件、注意事项等;

● 图形、表格、文字等晦涩难懂;

● 逻辑不清晰,该分类、分项、分步骤的没有给出;

正确性

● 技术原理、功能、规格等描述和软件不一致,存在错误;

● 原理图、架构图等存在错误;

● 命令、命令参数等错误;

● 代码片段错误;

● 命令无法完成对应功能;

● 界面错误,无法指导操作;

风险提示

● 对重要数据或系统存在风险的操作,缺少安全提示;

内容合规

● 违反法律法规,涉及政治、领土主权等敏感词;

● 内容侵权;

您对文档的总体满意度

非常不满意
非常满意
提交
根据您的反馈,会自动生成issue模板。您只需点击按钮,创建issue即可。