Skip to content

Commit dd24e8d

Browse files
fslongjinfslongjin
authored
doc: 添加SIG模版 (#7)
* doc: 添加SIG模版 * 添加contributing的todo
1 parent edad785 commit dd24e8d

File tree

9 files changed

+175
-3
lines changed

9 files changed

+175
-3
lines changed

‎.vuepress/config.js

+35
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ export default defineUserConfig({
3838
'text': 'SIGs',
3939
'link': '/sigs/',
4040
},
41+
{
42+
'text': '工作组',
43+
'link': '/wgs/',
44+
},
4145
{
4246
'text': "导师制",
4347
'link': '/mentorship/',
@@ -81,6 +85,37 @@ export default defineUserConfig({
8185
]
8286
}
8387
],
88+
'/sigs/': [
89+
{
90+
text: 'SIGs',
91+
children: [
92+
'/sigs/',
93+
]
94+
},
95+
{
96+
text: 'SIG模版',
97+
children: [
98+
'/sigs/sig-template/',
99+
'/sigs/sig-template/charter.md',
100+
'/sigs/sig-template/contributing.md',
101+
]
102+
}
103+
],
104+
'/wgs/': [
105+
{
106+
text: '工作组',
107+
children: [
108+
'/wgs/',
109+
]
110+
},
111+
{
112+
text: '工作组模版',
113+
children: [
114+
'/wgs/wg-template/',
115+
]
116+
}
117+
],
118+
84119
}
85120
}
86121
),

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ DragonOS社区官方支持以下类型的团体：
5353

5454
## 社区成员资格
5555

56-
我们鼓励所有贡献者成为社区成员。我们的目标是发展一个由贡献者、审阅者和代码维护者组成的活跃、健康的社区。在我们的[社区成员资格]页面中了解有关会员资格要求和责任的更多信息。
56+
我们鼓励所有贡献者成为社区成员。我们的目标是发展一个由贡献者、审阅者和代码维护者组成的活跃、健康的社区。在我们的[社区成员资格]页面中了解有关成员资格要求和责任的更多信息。
5757

5858
[社区治理]: governance/README.md
5959
[社区交流]: communication/README.md

‎governance/community-membership.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ Approver状态限定于代码库的一部分。
149149

150150
然而，成为DragonOS社区的GitHub组织 的一员，意味着拥有[一些权限]。这些能力不应该被那些不熟悉DragonOS项目当前情况的人使用。
151151

152-
因此，那些长时间离开项目且没有任何活动的成员将被从 DragonOS社区的GitHub组织 中移除，并且在他们重新熟悉项目的当前状态后，将需要再次通过组织成员资格审查及晋升流程。
152+
因此，那些长时间离开项目且没有任何活动的成员**将被从 DragonOS社区的GitHub组织 中移除**，并且在他们重新熟悉项目的当前状态后，将需要再次通过组织成员资格审查及晋升流程。
153153

154154

155155
### 如何衡量非活跃状态

‎governance/sig-governance/README.md

+14
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,20 @@
8080
- 应该确保有一个健康的讨论和决策流程。
8181
- 可以做出决策以解决冲突
8282

83+
## 子项目
84+
85+
### 子项目创建
86+
87+
88+
子项目可以通过 SIG 技术负责人的简单多数投票创建。
89+
- SIG的`README.md`必须更新，以把子项目信息囊括在里面。
90+
- 如果子项目的流程与 SIG 治理不同，则必须有一个文档来记录差异。例如，如果子项目单独发布 - 它们必须记录发布和规划是如何执行的
91+
92+
### 子项目的要求
93+
94+
子项目大致分为两类，一类是DragonOS kernel本身以及与其关联性较强的部分，称为DragonOS核心子项目；另一类则是与DragonOS kernel发布周期不直接关联的部分，称为DragonOS周边子项目。
95+
96+
影响 SIG 中多个子项目的问题应由 SIG 的负责人或各个子项目负责人联合解决。
8397

8498
## SIG 的撤销
8599

‎governance/wg-governance/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,4 +87,4 @@ PR合并后，工作组正式成立，直到它完成声明的目标，或自愿
8787

8888
[年度报告]: /governance/annual-reports.md
8989
[SIG和WG的生命周期]: /governance/sig-wg-lifecycle.md
90-
[社区成员]: governance/community-membership.md
90+
[社区成员]: /governance/community-membership.md

‎sigs/sig-template/README.md

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# SIG-template
2+
3+
> 这个目录下是SIG信息的模版，当你申请成立新的SIG的时候，需要填写相关的内容。
4+
5+
（这里是一段SIG的简介）SIG-template维护了XXXXX，它的目标是XXXX。
6+
7+
8+
该[章程](charter.md)定义了SIG-template的范围和治理相关的内容。
9+
10+
## 会议
11+
12+
- SIG定期会议：**北京时间 周五 10:00** （每两周一次）
13+
- 会议记录和议程 （这里要指向对应的文档链接）
14+
- 会议视频 （指向DragonOS社区官方bilibili账号下，每个SIG的合集链接）
15+
16+
17+
## SIG管理层
18+
19+
### 主席
20+
21+
SIG 主席负责管理 SIG 的运营和流程。
22+
23+
- 某人 （这里指向他的github账户），（这里写他所属的公司、组织，或者是独立个人）
24+
- 龙进 [@fslongjin](https://github.com/fslongjin)，华南理工大学
25+
26+
## 联系方式
27+
28+
- BBS版块： （这里放指向bbs的版块的链接）
29+
- GitHub团队
30+
- @DragonOS-Community/sig-xxxxxxx-bugs - 故障分类和排查团队
31+
- PMC联络人：张三 （这里指向他的github账户）
32+
33+
## 工作组
34+
35+
以下是SIG-template参与并支持的[工作组]
36+
37+
- [示例工作组]
38+
39+
40+
## 子项目列表
41+
42+
以下[子项目]归SIG-template所有:
43+
44+
### 这是一个子项目的名称
45+
46+
（一句话简介）这个子项目负责......
47+
48+
#### 子项目Maintainer
49+
50+
- 张三 （这里指向他的github账户）
51+
52+
## 子项目的详细信息
53+
54+
### 这是一个子项目的名称
55+
56+
这个子项目的详细介绍，需要给出一些信息以便潜在参与者能知道该子项目目前正在进行的工作，以及参与开发需要做什么。
57+
58+
59+
60+
61+
[工作组]: /governance/dev-group.md#WG（工作组）
62+
[子项目]: /governance/dev-group.md#子项目
63+
[示例工作组]: /wgs/wg-template/README.md
64+

‎sigs/sig-template/charter.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# SIG架构章程
2+
3+
本章程遵循[SIG治理文档]中描述的约定，并使用[SIG章程指南]中概述的角色和组织管理。
4+
5+
6+
7+
8+
## 范围
9+
10+
SIG-template维护并发展了xxxxxxx，（一句话简介范围）
11+
12+
### 属于当前SIG的范围
13+
14+
15+
#### xxxxxx
16+
17+
- 范围定义1
18+
- 范围定义2
19+
20+
#### yyyyy
21+
22+
- 范围定义1
23+
- 范围定义2
24+
25+
26+
### 不属于当前SIG的范围
27+
28+
- aaaaaa
29+
- bbbbbb
30+
31+
## 角色和组织管理
32+
33+
该部分遵循[SIG治理文档]中描述的角色和组织管理，并**对/不对**[SIG治理文档]描述的角色职责进行更改
34+
35+
### 主席的额外职责
36+
37+
> 这部分根据每个SIG自己来定
38+
39+
- 在每次 SIG 会议之前管理和策划与所有子项目相关的项目板，以便进行讨论
40+
- 确保在会议前 24 小时填写议程，否则会议将被取消
41+
- 尽可能在活动和社区会议上报告 SIG 状态
42+
- 积极促进 SIG 的多样性和包容性
43+
- 遵守 Kubernetes 行为准则，尤其是在个人行为和责任方面
44+
45+
### 与[SIG治理文档]的差异
46+
47+
> 这部分可有可无，如果没有的话就写“无差异”
48+
49+
### 子项目创建
50+
51+
参见[SIG治理文档的子项目创建部分]
52+
53+
[SIG治理文档]: /governance/sig-governance/README.md
54+
[SIG治理文档的子项目创建部分]: /governance/sig-governance/README.md#子项目创建
55+
[SIG章程指南]: /governance/sig-governance/sig-charter-guide.md

‎sigs/sig-template/contributing.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# 为SIG-template作出贡献
2+
3+
TODO

‎wgs/wg-template/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# WG模版

0 commit comments

Comments
 (0)