community/sig/README.md

58 lines
3.5 KiB
Markdown
Raw Normal View History

2021-02-01 11:06:20 +08:00
# SIG管理章程
## 背景
SIGSpecial Interest Group是指特别兴趣小组SIG在PMC项目管理委员会指导下负责OpenHarmony社区特定子领域及创新项目的架构设计、开源开发及项目维护等工作。
2021-02-01 11:06:20 +08:00
本目录用于存放OpenHamony社区所有 “特别兴趣小组”Special Interest Group以下简称 SIG的运作信息。
## 申请新建SIG
1. 开发者在社区中寻找2-3个有共同兴趣及目标的人确定SIG Leader。参考[新建SIG Charter](sig-template/sig-charter-template_cn.md)模板创建SIG Charter提案。
2. SIG Leader以[SIG-Charter-Proposal-XXX]为邮件标题,需先订阅[dev@openharmony.io](https://lists.openatom.io/postorius/lists/dev.openharmony.io/)然后向dev@openharmony.io发送邮件提交新建SIG申请。
3. PMC项目管理委员会批准通过后可创建新的SIG。
## 加入已有SIG
开发者可通过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成员。
- sigs.json为了便于工具自动提取其中SIG的maintainer/committer信息单独备份一份至OWNER文件内每个SIG所维护的仓库名称列表/目录结构位于sigs.json文件中。
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。
2021-02-01 11:06:20 +08:00
### sigs.json 文件格式
| 字段 | 说明 |
|:---|:---|
| sig-name | SIG名称 |
| projects| gitee仓名 |
2021-02-01 11:06:20 +08:00
| project-path | OpenHarmony下的归档路径若不涉及回合OpenHarmony填写NONE |
2021-02-01 11:06:20 +08:00
### sigs.json 样例
```
"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"]
},
]
}
```