diff --git a/sig/README.md b/sig/README.md index 3f0220cbfbb4709c9617ac25ee81b4b7043ab3e9..f243a20b23216114106381a4a7eaca887ebf6ee6 100644 --- a/sig/README.md +++ b/sig/README.md @@ -1,17 +1,30 @@ # SIG管理章程 ## 背景 -SIG(Special Intertest Group)是指特别兴趣小组,SIG在PMC项目管理委员会指导下,负责OpenHarmony社区特定子领域的架构设计、开源开发及项目维护等工作。 +SIG(Special Intertest Group)是指特别兴趣小组,SIG在PMC项目管理委员会指导下,负责OpenHarmony社区特定子领域及创新项目的架构设计、开源开发及项目维护等工作。 本目录用于存放OpenHamony社区所有 “特别兴趣小组”(Special Interest Group,以下简称 SIG)的运作信息。 -## 申请新SIG -1. 请参考[新建SIG申请模板](sig-template/sig_template_cn.md)提交申请。 - Fork OpenHamony/community到你的Gitee下,并在sig目录下创建你的sig申请文件。 -2. 开发者通过向dev@openharmony.io发送新建SIG Proposal邮件申请,经PMC项目管理委员会审核后可创建新SIG。 +## 申请新建SIG +1. 开发者在社区中寻找2-3个有共同兴趣及目标的人,确定SIG Leader。参考[新建SIG申请](sig-template/oep_cn.md)模板,创建SIG提案。此模板参考自[KEP模板](https://github.com/kubernetes/enhancements/blob/master/keps/NNNN-kep-template/README.md)。 +2. SIG Leader以[New-SIG-Proposal-XXX]为邮件标题,通过向dev@openharmony.io发送邮件,提交新建SIG申请。 +3. PMC项目管理委员会批准通过后,可创建新的SIG。 +## 加入已有SIG +1. 开发者可通过SIG列表查看感兴趣的SIG,通过订阅邮件列表、参与SIG会议等形式,参与对应SIG项目的技术讨论、社区维护及开源开发。 + +## 运营维护SIG +1. SIG Leader Fork OpenHamony/community分支,在SIG文件夹下,以新SIG名称新建文件夹,并参考[SIG模板](sig-template/),创建对应的SIG配置文件,并提交PR合入申请。 +2. SIG孵化子项目,统一存放在[OpenHarmony SIG组织](https://gitee.com/openharmony-sig),待孵化成熟后,可合入OpenHarmony组织代码主库。 +3. SIG Leader及Committer负责对应SIG的运营及维护。 +4. SIG Leader定期在PMC项目管理委员会汇报SIG孵化项目及SIG运营进展,PMC基于SIG运作情况给出指导建议。 + +## SIG孵化项目毕业 +1. SIG孵化项目成熟并满足项目毕业要求后,可申请合入OpenHarmony组织代码主库。 +2. SIG Leader通过向dev@openharmony.io发送邮件,提交孵化项目毕业申请。 +3. PMC项目管理委员会通过项目毕业申请后,社区接纳孵化项目合入OpenHarmony主干。 ### SIG数据存放和管理方式 SIG信息记录统一归档在OpenHamony/community仓库的sig目录内,sig_xxx.md/sig_xxx_cn.md包括SIG组工作目标和范围、SIG管理的repository及描述、SIG组织会议、SIG成员;为了便于工具自动提取,其中SIG的maintainer/committer信息单独备份一份至OWNER文件内,每个SIG所维护的仓库名称列表/目录结构位于sigs.json文件中。 -1. OpenHarmonyr/community仓的sig目录下存在一个sigs.json文件,这个文件中管理从PMC看到的所有SIG的信息。 +1. OpenHarmony/community仓的sig目录下存在一个sigs.json文件,这个文件中管理从PMC看到的所有SIG的信息。 2. sigs 由 PMC 修改和维护,新sig申请由对应的 maintainer 提交PR,经过PMC审视后合入。 3. sig 独立目录下的sig_xxx_cn.md/sig_xxx.md 为 sig 的信息展示区。其中SIG基本信息需按模板留空,新建SIG时填写完整。 4. sig 独立目录下的OWNER存放相应sig的maintainer。 @@ -21,23 +34,22 @@ SIG信息记录统一归档在OpenHamony/community仓库的sig目录内,sig_xx | 字段 | 说明 | |:---|:---| | sig-name | SIG名称 | -| project-name | gitee仓名 | +| projects| gitee仓名 | | project-path | OpenHarmony下的归档路径,若不涉及回合OpenHarmony填写NONE | ### sigs.json 样例 ``` - { - "sigs-List":[ - { - "sig-name":"sig-docs", - "project-name":"docs", - "project-path":"docs/" - }, - { - "sig-name ":"sig-updates", - "project-name":"updates", - "project-path":"base/updates/" - }, - ] - } +"sigs-List":[ + { + "sig-name":"sig-docs", + "projects":"https://gitee.com/openharmony-sig/docs", + "project-path":"docs/" + }, + { + "sig-name ":"sig-updates", + "projects":["https://gitee.com/openharmony/startup_appspawn_lite", "https://gitee.com/openharmony/startup_bootstrap_lite"] + "project-path":["base/startup/appspawn_lite", "base/startup/bootstrap_lite"] + }, + ] +} ``` diff --git a/sig/sig-template/oep_cn.md b/sig/sig-template/oep_cn.md new file mode 100644 index 0000000000000000000000000000000000000000..bf8a77a3ae0adc4524d041e24d445d57b623ce00 --- /dev/null +++ b/sig/sig-template/oep_cn.md @@ -0,0 +1,12 @@ +- [摘要](#summary) +- [目标](#goals) +- [提案](#proposal) + - [用户场景(可选)](#user-scenario-optional) + - [风险](#risks) +- [设计细节](#design-details) + - [测试计划](#test-plan) + - [升级/降级策略](#upgrade-downgrade-strategy) + - [版本策略](#version-strategy) +- [备选方案](#alternatives) +- [基础设施(可选)](#infrastructure-optional) + diff --git a/sig/sig-template/oep_en.md b/sig/sig-template/oep_en.md new file mode 100644 index 0000000000000000000000000000000000000000..b234472ef305631be691527e9018046474e21a3c --- /dev/null +++ b/sig/sig-template/oep_en.md @@ -0,0 +1,12 @@ +- [Summary](#summary) +- [Goals](#goals) +- [Proposal](#proposal) + - [User Scenario(Optional)](#user-scenario-optional) + - [Risk](#risks) +- [Design Details](#design-details) + - [Test Plan](#test-plan) + - [Upgrade/Downgrade Strategy](#upgrade-downgrade-strategy) + - [Version Strategy](#version-strategy) +- [Alternatives](#alternatives) +- [Infrastructure(Optional)](#infrastructure-optional) + diff --git a/sig/sig-template/sig_template.md b/sig/sig-template/sig_template.md index 67a8264cd616f6a7f132d9fb4412af3c13944413..9d3a7b562dc0293157a5fce75eeec9b0c1a4cb75 100644 --- a/sig/sig-template/sig_template.md +++ b/sig/sig-template/sig_template.md @@ -1,44 +1,34 @@ -# New SIG application +# SIG Template English | [简体中文](./sig_template_cn.md) Note: The content of this SIG follows the convention described in OpenHarmony's PMC Management Charter [README](/zh/pmc.md). ## SIG group work objectives and scope -Describe the scope and objectives of the newly applied SIG program, including but not limited to: - -Why do we need to create such a new SIG in OpenHarmony - -The business scope of the SIG - -The SIG needs to be supported by which SIGs in OpenHarmony ### work goals -### The scope of work +### work scope - - - -### The repository and description of the SIG management +### The repository - project name: - -repository1 name:https://gitee.com/openharmony-sig/docs + -repository1 name:https://gitee.com/openharmony/xxx -repository2 name:https://gitee.com/openharmony-sig/xxx -## SIG Related Information +## SIG Members ### Leader - -name1 [[@gitee_id1](https://gitee.com/gitee_id1)] +- @gitee account(https://gitee.com/xxx) + ### Committers - -name1 [[@gitee_id1](https://gitee.com/gitee_id1)] - -name2 [[@gitee_id3](https://gitee.com/gitee_id2)] - -name3 [[@gitee_id3](https://gitee.com/gitee_id3)] +- @gitee account(https://gitee.com/xxx) - ### Mailing Lists - -dev@openharmony.io + ### Meetings + - Meeting time:xxx + - Meeting link:xxx - ### Slack group - -http://openharmonyworkspace.slack.com - -The link to join the Slack group will be regularly updated in [OpenHarmony Community Code Warehouse](https://gitee.com/openharmony/community) +### Contact (optional) - ### Meeting - - meeting time: - -Conference link: -More about this source textSource text required for additional translation information +- Mailing list:xxx +- Slack group:xxx +- Wechat group:xxx diff --git a/sig/sig-template/sig_template_cn.md b/sig/sig-template/sig_template_cn.md index 78500aabbf0d0e97717c8f315292b73186f3284c..cded228cc70ae5f408b99894039c0b88654877fb 100644 --- a/sig/sig-template/sig_template_cn.md +++ b/sig/sig-template/sig_template_cn.md @@ -1,43 +1,34 @@ -# 新建SIG申请 +# SIG组模板 简体中文 | [English](./sig_template.md) 说明:本SIG的内容遵循OpenHarmony的PMC管理章程 [README](/zh/pmc.md)中描述的约定。 ## SIG组工作目标和范围 -用描述新申请SIG计划工作的范围和目标,包括但不限于: - - 为什么需要在OpenHarmony里创建一个这样的新SIG - - 该SIG的业务范围 - - 该SIG需要得到OpenHarmony内哪些SIG的支持 ### 工作目标 ### 工作范围 - - - -### 该SIG管理的repository及描述 -- 项目名称: - - repository1名称:https://gitee.com/openharmony-sig/docs +## 代码仓 +- 代码仓地址: + - repository1名称:https://gitee.com/openharmony/xxx - repository2名称:https://gitee.com/openharmony-sig/xxx - -## SIG 相关信息 +## SIG组成员 ### Leader - - name1 [[@gitee_id1](https://gitee.com/gitee_id1)] -### Committers - - name1 [[@gitee_id1](https://gitee.com/gitee_id1)] - - name2 [[@gitee_id3](https://gitee.com/gitee_id2)] - - name3 [[@gitee_id3](https://gitee.com/gitee_id3)] +- @码云账号(https://gitee.com/xxx) - ### 邮件列表 - - dev@openharmony.io +### Committers列表 +- @码云账号(https://gitee.com/xxx) - ### Slack 群组 - - http://openharmonyworkspace.slack.com - - 加入 Slack 群组的链接将定期更新在 [OpenHarmony Community代码仓](https://gitee.com/openharmony/community) ### 会议 - - 会议时间: - - 会议链接: + - 会议时间:xxx + - 会议链接:xxx + +### 联系方式(可选) + +- 邮件列表:xxx +- Slack群组:xxx +- 微信群:xxx