SIG参与指南

SIG 即 Special Interest Group，特殊兴趣小组。每个 SIG 围绕其对应的一个兴趣目标进行活动的开展，并将其活动成果回馈给整个社区。

各个 SIG 组会以公开透明的形式进行相关的小组活动，以便对某个特定方向感兴趣的社区贡献者可以方便的参与到对应的兴趣组之中。

  • 签署贡献者协议(CLA)

    参与技术贡献，需先签署贡献者协议。

    → 组织CLA签署

    → 个人CLA签署

  • 申请加入SIG小组

    加入SIG由对应SIG组审核，当前主要有linglong SIG在进行技术贡献、Linyaps Packaging SIG进行软件生态贡献。

  • 加入开发者交流群

    欢迎加入由社区维护的开发者社群，展开讨论

     

  • 创建新的SIG小组

    如果想更深入的参与到玲珑贡献中来，可以参考以下流程创建新的SIG组

SIG创建指南

SIG 的创建

SIG 的创建请求通过向 如意玲珑社区组织的SIG仓库发起 GitHub Pull Request 来发起 SIG创建评审流程，需要在此目录下根据指定格式创建 SIG 对应文件夹并放置对应文件。如意玲珑社区 SIG委员会 将通过对相应 Pull Request 的 Review 过程对申请进行评审。当 Pull Request 最终被合入后意味着 SIG 创建流程已经完成，组织管理员将会根据提交的 SIG材料以配置人员权限、创建对应的工作仓库。

* 该仓库中的SIG 小组文件夹仅用于存放记录基本信息的文件,如需存放源码等其他小组专有资源，请在创建步骤时编辑相关文件。

SIG 创建要求

在创建之前，请确认小组满足如下要求：

  • 小组兴趣和活动内容与 如意玲珑社区 具备相关性，包括但不限于生态贡献、下游发展等
  • 小组能够保持活动公开
  • 小组活动能够为整个 如意玲珑社区提供贡献产出
  • 小组必须存在至少两名成员（建议有至少五名成员时再进行创建）

* 活动开展平台可以为任意平台。对于公开的即时聊天平台，我们强烈建议小组在沟通时注意隐私保护。

* 为了方便小组进行贡献及保障团队写作体验，在小组提出仓库申请后，我们也会在小组建立时建立一个 sig- 前缀的仓库用于存放小组专有资源。如小组本身已有相关平台进行托管，请单独进行说明。

信息准备

在创建 SIG 时，你需要准备下列信息：

  • SIG 组名（推荐同时提供中英文名称）

  • 小组 ID（仅包含小写字母与连字符）

  • 创建原因

  • 小组简介

  • 活动范围与目标

  • 公开讨论渠道

  • 小组组员信息和小组管理员的 GitHub 账号信息

    当您准备就绪后，即可进行后续步骤。

创建步骤

您需要先 Fork 如意玲珑社区组织的SIG仓库，复制此目录下 .sig-template.zh_CN 目录内含的文件到该目录层级的一个新目录，以小组 ID 作为该新目录的名字，并编辑此目录下的文件以使其符合您要创建的小组的实际情况，最终推送修改并发起 Pull Request。

在编辑模板信息时，请注意模板中给出的描述。在 metadata.yml 声明的信息会被公开呈现，其中列出的成员将被邀请加入 如意玲珑社区 组织 OpenAtom-Linyaps 。

在发起 Pull Request 时，请以 [新 SIG 提案] SIG 名称 为格式作为 Pull Request 的标题，并按下面段落的格式，在描述区域提供小组的创建原因以及在metadata.yml中提供 SIG小组 管理员 GitHub 账号信息；在MEMBERS.md中提供 SIG小组 成员的GitHub 名称及主页。

## SIG 创建原因

在这里描述创建 SIG 的原因。

## 仓库创建

此 SIG 需在 OpenAtom-Linyaps 组织下创建如下仓库：

- sig-小组ID
- ...

（注：若小组不需要对应仓库，可直接删除“仓库创建”一节）
 
本环节所需提交的文件:

  • MEMBERS.md

  • metadata.yml

  • README.md

    若您或其它组员均对 GitHub 的 Pull Request 工作流程不熟悉，您也可以开启 Issue ，提供上述信息，来请求 SIG 委员会协助创建。

    *注：尽管这里允许 SIG 在 OpenAtom-Linyaps 创建用来放置小组项目的仓库，但小组的活动并不强制要求在本组织下进行，小组可选择任何合适的公开位置进行 SIG 活动的展开，例如使用其它 GitHub 组织，或是使用其它平台，例如 Gitee。

后续步骤

Pull Request 发起后，SIG 委员会会在三个工作日内予以反馈。若提出了反馈意见，则申请人或其它小组成员应在 Pull Request 中与委员会进行讨论并达成一致。

当 Pull Request 最终被合入时，SIG 即创建完成。若最终决定不再创建 SIG，则可直接关闭对应的 Pull Request。

SIG 变更申请流程

当小组需要更新小组的相关信息时，仍通过常规 Pull Request 的形式对已有文件进行编辑，并由 SIG 委员会评审后，通过合入的形式完成编辑。

若您或其它组员均对 GitHub 的 Pull Request 工作流程不熟悉，您也可以开启 Issue ，提供要编辑的信息，来请求 SIG 委员会协助。

后期仓库申请流程

当小组在成立后需要创建额外的新仓库，请以 [新 SIG 仓库 申请] SIG 名称 为格式作为 Issues 的标题，并按下面段落的格式，在描述区域提供小组的创建原因。

## 新 SIG仓库 申请原因

在这里描述申请新 SIG仓库 的原因。

其他