提交 0601b40a 编写于 作者: J jinguang

!1467 optimiz sig governance description

* Description:[fix] optimiz sig governance description
上级 5592fec0
# SIG 管理指南
**SIG 管理指南**
目录
该文档是 OpenHarmony 社区中的 SIG(Special Interest Group)管理指南初稿。为了保证 SIG 的有效管理和发展,该文档提供了申请新 SIG 的具体流程以及仓库管理和孵化准出的操作指南。
# 1. **申请创建新SIG流程**
为了保证OpenHarmony社区中SIG的有效管理和发展,需要有规范的流程和评审机制进行支撑,以下是申请新SIG的具体流程:
## 1.1 梳理SIG组工作目标和范围
在申请新的SIG之前,需要先梳理好该SIG组的工作目标和范围。这个步骤是为了确保SIG组的工作方向和范围能够清晰地呈现,同时也为后续的申请做好准备。
参考SIG申请[模板](../meeting-notes/docs/openharmony_sig_template.pptx),该模板中包含了申请时需要填写的相关信息和要求。
## 1.2 提交SIG申请议题
在完成SIG申请模板的填写后,需要将[申请议题](https://docs.qingque.cn/s/home/eZQB8yRFQfEFeAxk\_6JKZEE0q?identityId=1tbICPd8j3s)提交给OpenHarmony社区的PMC。该步骤的主要作用是让OpenHarmony社区的PMC能够对该申请进行初步审核。
- [申请新SIG流程](#id1)
- [SIG变更批准流程](#id2)
- [增删新项目或repository申请流程](#id2-1)
- [变更团队成员申请流程](#id2-3)
<h2 id="id1">申请新SIG流程</h2>
说明:
所有OpenHarmony社区的SIG都必须有一个章程(Charter)来明确SIG的范围和治理规则。
+ 范围必须明确定义SIG负责指导和维护的领域
+ 治理规则必须说明SIG中的职责,以及拥有这些职责的角色和工作开展方式
具体的申请流程如下:
**1、使用SIG模板创建自己的新SIG**
将 gitee.com/openharmony/community Fork到你的Gitee下。并在sig目录下创建你的sig文件夹,以及把SIG申请模板拷贝到该文件夹下。
## 1.3 PMC会议评审
当PMC会议通过SIG申请议题时,即可进行如下步骤操作。
### 1.3.1 创建自己的新申请SIG:
首先需要将OpenHarmony社区的代码库Fork到自己的Gitee下,并在sig目录下创建自己的SIG文件夹,再将SIG申请模板(sig_template)拷贝到该文件夹下。使用SIG模板创建自己的新SIG,并根据需要进行信息填写。
```
git clone https://gitee.com/YOURGITEE/community
......@@ -34,185 +22,45 @@ cd ./community/sig
cp -r sig_template sig_YOURSIGNAME
cd sig_YOURSIGNAME
```
**2、完成新SIG章程的填写**
为便于更好的理解和填写[SIG申请模板](./../../../sig/sig_template/sig_template_cn.md)里的内容,建议先阅读[建议书和要求](./sig_governance.md),完成新SIG的申请填写。
### 1.3.2 新申请SIG组信息填写
在创建好自己的新SIG之后,需要根据需要完成新SIG组的信息填写。为便于更好的理解和填写SIG申请模板里的内容,建议先参考已有SIG的描述和说明。
```
mv sig_template_cn.md sig_YOURSIGNAME_cn.md
mv sig_template.md sig_YOURSIGNAME.md
vi sig_YOURSIGNAME_cn.md
vi sig_YOURSIGNAME.md
```
**3、完成新SIG成员的配置**
请在OWNERS文件中完成对SIG成员的配置
```
vi OWNERS
vim sig_YOURSIGNAME_cn.md
vim sig_YOURSIGNAME.md
```
**4、完成新SIG的Repository的配置**
- 如果您的项目在OpenHarmony社区新增子模块,请提交PR至[manifest仓](https://gitee.com/openharmony/manifest),在其中按照格式把你的项目添加进来,其中PR提交中必须包含如下说明信息:
1. 新增仓路径:kernel_liteos_a
2. 新增仓库名:https://gitee.com/openharmony/kernel_liteos_a
3. 新增仓库描述:为什么需要在OpenHarmony里创建一个这样的新仓,业务功能描述
4. committer owner刷新:zh/committer.md
5. docs刷新: 如果涉及资料刷新,需要提供对应的描述链接
- 如果不是以上的情况,请单击[sigs.json](/sig/sigs.json),并按照内部的格式在文件的最后把您的SIG添加进来
### 1.3.3 新SIG组织信息配置
在完成新SIG组的信息填写后,还需要完成新SIG组织信息的配置。这个配置文件将会被用于后续SIG组仓库的创建,因此需要准确填写。
```
vi ../../sig/sigs.json
vim sig/sigs\_list.toml
```
**5、在sig文件夹的sigs.json内添加新SIG的相关信息**
根据以上的信息,打开sig文件夹下[sigs.json](/sig/sigs.json)文件,在末尾添加新sig的相关信息并提交PR。
```
vi ../sigs.json
```
**6、提交PR**
将以上修改提交到Gitee上,并在Gitee上创建一个Pull Request。
**7、向PMC发送邮件申请**
给技术委员会发邮件(邮箱<PMC@openharmony.io>),并在正文中包含主题“[*新SIG提案]*”和PR的链接
**8、PMC评审并反馈意见**
项目管理委员会通常会在发送申请后的一周内反馈。如果遇到假期或重要会议等因素,可能会需要更长时间。在此期间,您可以进行任何有需要的更改
**11.PMC评审通过并合入**
PMC将通过合并Pull Request的方式来批准您的申请
<h2 id="id1">SIG变更申请流程</h2>
如果您要修改SIG章程(repository_governance.md)、团队成员(OWNERS)、增删Repository(Repository)等,您需要提交SIG变更批准流程。
<h3 id="id2-1">增删新项目或repository申请流程</h3>
**1、完成新项目的Repository的配置或删除相关配置**
- 如果您的项目在OpenHarmony社区删除子模块,请至[manifest仓](https://gitee.com/openharmony/manifest),找到待删除的repository进行删除并提交PR,提交PR需要提供如下信息。
1. 删除仓路径:xxx
2. 删除仓库名:https://gitee.com/openharmony/xxx
3. 删除仓库描述:为什么需要在OpenHarmony里删除这个仓,删除后的影响是什么
**2、在sig文件夹的sig.yaml内添加新项目的repository信息或删除相关信息**
根据以上的信息,打开sig文件夹下[sigs.json](/sig/sigs.json)文件,在末尾添加新sig的相关信息并提交PR。
```
vi ../sigs.json
```
**4、提交PR**
将以上修改提交到Gitee上,并在Gitee上创建一个Pull Request。
**5、向PMC发送邮件申请**
给技术委员会发邮件(邮箱<pmc@openharmony.io>),并在正文中包含主题“[*增删repository提案]*”和PR的链接
**6、PMC评审并反馈意见**
项目管理委员会通常会在发送申请后的一周内反馈。如果遇到假期或重要会议等因素,可能会需要更长时间。在此期间,您可以进行任何有需要的更改
**7.PMC评审通过并合入**
项目管理委员会将通过合并Pull Request的方式来批准您的申请
#### 内部变更申请流程
**只影响本SIG范围内的变更**,只需要SIG内的Maintainer达成一致,请走以下流程
**1、修改SIG章程**
请在`/community/sig`文件夹下找到您的sig文件夹,完成sig文件夹内SIG章程的修改
```
vi sig_YOURSIGNAME_cn.md
vi sig_YOURSIGNAME.md
```
**2、刷新README**
请视需要,根据修改的章程同步刷新README内的“项目清单”下内容,便于大家了解
```
vi README.md
```
**3、提交PR**
将以上修改提交到Gitee上,并在Gitee上创建一个Pull Request。
**4、在SIG内部发送邮件申请**
给您所对应的sig团队的邮箱列表发邮件申请,可以在正文中包含主题“[*修改SIG章程提案]*”和PR的链接。如果之前在SIG团队内对此变更已经有讨论,可以省略该步骤
**5、SIG内部评审并给出意见**
如果您的SIG内部已经有评审意见,可以省略该步骤。
**6.PMC评审通过并合入**
SIG的Maintainer合并Pull Request来批准申请。
<h3 id="id2-2">变更团队成员申请流程</h3>
团队成员的刷新由SIG内部自己维护
**1.完成新SIG成员的配置**
请在`/community/sig`文件夹下找到您的sig文件夹,完成sig文件夹内SIG章程的修改,在OWNERS文件中完成对SIG成员的配置
```
vi OWNERS
```
**2. 提交PR**
将以上修改提交到Gitee上,并在Gitee上创建一个Pull Request。
**3. 在SIG内部发送邮件申请**
### 1.3.4 SIG组运作规范:
SIG组需要定期召开例会,讨论和总结SIG组领域工作,并向OpenHarmony PMC组织进行定期汇报。如果SIG组中的Leader角色有变动,需要及时知会OpenHarmony社区PMC成员,并对组织信息和仓库权限进行相应的调整。
给您所对应的sig团队的邮箱列表发邮件申请,可以在正文中包含主题“[*修改SIG章程提案]*”和PR的链接。如果之前在SIG团队内对此变更已经有讨论,可以省略该步骤
# 2. **仓库管理**
## 2.1 SIG组仓库新增、退休、更名申请:
### 2.1.1 申请架构SIG评审
参考[模板1--新增、退休、更名](../sig/sig_architecture/meetings/repository_review_template.pptx)准备对应的申请材料,申请架构SIG议题评审。
**4. SIG内部评审并给出意见**
参考[模板2--开源软件引入](../sig/sig_architecture/meetings/OpenHarmony_thirdparty_opensource_software_selection_analysis_templateV1.0.pptx)准备对应的申请材料,申请架构SIG议题评审。
如果您的SIG内部已经有评审意见,可以省略该步骤。
### 2.1.2 新增仓电子流申请:
[操作指导](http://ci.openharmony.cn/workbench/ciCommunity):“操作指南” --> "SIG管理" --> “SIG仓申请”。
### 2.1.3 仓库退休、更名电子流申请:
[操作指导](http://ci.openharmony.cn/workbench/ciCommunity):“操作指南” --> "SIG管理" --> “仓管理”。
**5. PMC评审通过并合入**
## 2.2 SIG孵化准出:
### 2.2.1 申请架构SIG孵化预审:
[申请议题](https://shimo.im/sheets/StzhuFkEk38enrnl/MODOC)进行孵化准出架构预审,参考[模板](../sig/sig_architecture/meetings/repository_review_template.pptx) 准备对应的申请材料。
SIG的Maintainer合并Pull Request来批准申请。
### 2.2.2 申请质量SIG孵化准出评审:
[申请议题](https://shimo.im/sheets/6QqqWJX99xrWWqJg/MODOC):进行孵化准出评审,参考[准出标准](../sig/sig_qa/guidance_for_incubation_project_graduation_cn.md)准出孵化准出材料。
### 2.2.3. 提交仓库孵化准出电子流:
质量SIG准出评审通过后,提交[孵化准出电子流](http://ci.openharmony.cn/workbench/ciCommunity): “操作指南” --> "SIG管理" --> “孵化报告”。
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册