Skip to content

Commit 2a04222

Browse files
committed
Add more prominent details around SIGs/WG/Committees
Signed-off-by: Joe Beda <[email protected]>
1 parent 1cb83ad commit 2a04222

File tree

2 files changed

+60
-31
lines changed

2 files changed

+60
-31
lines changed

README.md

+23-8
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,27 @@ issues, mailing lists, conferences, etc.
1313

1414
For more specific topics, try a SIG.
1515

16-
## SIGs
16+
## Governance
1717

18-
Kubernetes is a set of subprojects, each shepherded by a Special Interest Group (SIG).
18+
Kubernetes has three types of groups that are officially supported:
1919

20-
A first step to contributing is to pick from the [list of kubernetes SIGs](sig-list.md).
20+
* **Committees** are named sets of people that are chartered to take on sensitive topics.
21+
This group is encouraged to be as open as possible while achieving its mission but, because of the nature of the topics discussed, private communications are allowed.
22+
Examples of committees include the steering committee and things like security or code of conduct.
23+
* **Special Interest Groups (SIGs)** are persistent open groups that focus on a part of the project.
24+
SIGs must have open and transparent proceedings.
25+
Anyone is welcome to participate and contribute provided they follow the Kubernetes Code of Conduct.
26+
The purpose of a SIG is to own and develop a set of **subprojects**.
27+
* **Subprojects** Each SIG can have a set of subprojects.
28+
These are smaller groups that can work independently.
29+
Some subprojects will be part of the main Kubernetes deliverables while others will be more speculative and live in the `kubernetes-sigs` github org.
30+
* **Working Groups** are temporary groups that are formed to address issues that cross SIG boundaries.
31+
Working groups do not own any code or other long term artifacts.
32+
Working groups can report back and act through involved SIGs.
33+
34+
See the [full governance doc](governance.md) for more details on these groups.
2135

22-
A SIG can have its own policy for contribution,
23-
described in a `README` or `CONTRIBUTING` file in the SIG
24-
folder in this repo (e.g. [sig-cli/CONTRIBUTING](sig-cli/CONTRIBUTING.md)),
25-
and its own mailing list, slack channel, etc.
36+
A SIG can have its own policy for contribution, described in a `README` or `CONTRIBUTING` file in the SIG folder in this repo (e.g. [sig-cli/CONTRIBUTING.md](sig-cli/CONTRIBUTING.md)), and its own mailing list, slack channel, etc.
2637

2738
If you want to edit details about a SIG (e.g. its weekly meeting time or its leads),
2839
please follow [these instructions](./generator) that detail how our docs are auto-generated.
@@ -34,7 +45,11 @@ lead to many relevant technical topics.
3445

3546
## Contribute
3647

37-
The [Contributor Guide](contributors/guide/README.md) provides detailed instructions on how to get your ideas and bug fixes seen and accepted, including:
48+
A first step to contributing is to pick from the [list of kubernetes SIGs](sig-list.md).
49+
Start attending SIG meetings, join the slack channel and subscribe to the mailing list.
50+
SIGs will often have a set of "help wanted" issues that can help new contributors get involved.
51+
52+
The [Contributor Guide](contributors/guide/README.md) provides detailed instruction on how to get your ideas and bug fixes seen and accepted, including:
3853
1. How to [file an issue]
3954
1. How to [find something to work on]
4055
1. How to [open a pull request]

governance.md

+37-23
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ See [community membership]
2626
# Community groups
2727

2828
The project has 4 main types of groups:
29-
1. Special Interest Groups, SIGs
30-
2. Subprojects
31-
3. Working Groups, WGs
32-
4. Committees
29+
* Special Interest Groups, SIGs
30+
* Subprojects
31+
* Working Groups, WGs
32+
* Committees
3333

3434
## SIGs
3535

@@ -52,8 +52,8 @@ itself. Examples:
5252
* Horizontal: Scalability, Architecture
5353
* Project: Testing, Release, Docs, PM, Contributor Experience
5454

55-
SIGs must have at least one and ideally two SIG leads at any given
56-
time. SIG leads are intended to be organizers and facilitators,
55+
SIGs must have at least one and ideally two SIG chairs at any given
56+
time. SIG chairs are intended to be organizers and facilitators,
5757
responsible for the operation of the SIG and for communication and
5858
coordination with the other SIGs, the Steering Committee, and the
5959
broader community.
@@ -62,7 +62,8 @@ Each SIG must have a charter that specifies its scope (topics,
6262
subsystems, code repos and directories), responsibilities, areas of
6363
authority, how members and roles of authority/leadership are
6464
selected/granted, how decisions are made, and how conflicts are
65-
resolved. A [short template] for intra-SIG governance has been
65+
resolved. See the [SIG charter process] for details on how charters are managed.
66+
A [short template] for intra-SIG governance has been
6667
developed in order to simplify SIG creation, and additional templates
6768
are being developed, but SIGs should be relatively free to customize
6869
or change how they operate, within some broad guidelines and
@@ -79,7 +80,7 @@ community.
7980
See [sig governance] for more details about current SIG operating
8081
mechanics, such as mailing lists, meeting times, etc.
8182

82-
## Subprojects
83+
### Subprojects
8384

8485
Specific work efforts within SIGs are divided into **subprojects**.
8586
Every part of the Kubernetes code and documentation must be owned by
@@ -106,15 +107,28 @@ This is the purpose of Working Groups (WG). The intent is to make
106107
Working Groups relatively easy to create and to deprecate, once
107108
inactive.
108109

109-
To propose a new working group, first find a SIG to sponsor the group.
110+
Working groups do not own any code or subprojects. Instead, they are a place for
111+
people to discuss topics that cross SIG boundaries.
112+
113+
Working groups are primarily used to facilitate topics of discussion that are in
114+
scope for Kubernetes but that cross SIG lines. If a set of folks in the
115+
community want to get together and discuss a topic, they can do so without
116+
forming a Working Group. As a community we will be looking for other ways to
117+
highlight and encourage a larger ecosystem (with things like slack channels)
118+
without offering any official endorsement.
119+
120+
To propose a new working group, first find a SIG to sponsor the group.
110121
Next, send a proposal to [email protected] and also include
111-
any potentially interested SIGs. Wait for public comment. If there's
112-
enough interest, a new Working Group should be formed.
122+
any potentially interested SIGs. Wait for public comment. If there's
123+
enough interest, a new Working Group should be formed.
113124

114-
Create a new mailing list in the from of kubernetes-wg-group-name. Working
125+
Create a new mailing list in the from of kubernetes-wg-group-name. Working
115126
groups typically have a Slack channel as well as regular meetings on zoom.
116127
It's encouraged to keep a clear record of all accomplishments that's publicly
117-
accessible.
128+
accessible. Like SIGs, working group communications and meetings should be
129+
open and be recorded for later viewing.
130+
131+
Working groups are documented in [sigs.yaml](sigs.yaml).
118132

119133
## Committees
120134

@@ -124,7 +138,7 @@ open and anyone can join, Committees do not have open membership and do
124138
not always operate in the open. The steering committee can form
125139
committees as needed, for bounded or unbounded duration. Membership
126140
of a committee is decided by the steering committee. Like a SIG, a
127-
committee has a charter and a lead, and will report to the steering
141+
committee has a charter and a chair, and will report to the steering
128142
committee periodically, and to the community as makes sense, given the
129143
charter.
130144

@@ -151,17 +165,15 @@ to its charter, will own the decision. In the case of extended debate
151165
or deadlock, decisions may be escalated to the Steering Committee,
152166
which is expected to be uncommon.
153167

154-
The exact processes and guidelines for such cross-project
155-
communication have yet to be formalized, but when in doubt, use
156-
[email protected] and make an announcement at the
157-
community meeting.
168+
The [KEP process] is being developed as a way to facilitate definition, agreement and communication of efforts that cross SIG boundaries.
169+
SIGs are encouraged to use this process for larger efforts.
170+
This process is also available for smaller efforts within a SIG.
158171

159172
# Repository guidelines
160173

161-
All repositories under Kubernetes github orgs, such as kubernetes and kubernetes-incubator,
162-
should follow the procedures outlined in the [incubator document](incubator.md). All code projects
163-
use the [Apache License version 2.0](LICENSE). Documentation repositories should use the
164-
[Creative Commons License version 4.0](https://git.k8s.io/website/LICENSE).
174+
All new repositories under Kubernetes github orgs should follow the process outlined in the [kubernetes repository guidelines].
175+
176+
Note that "Kubernetes incubator" process has been deprecated in favor of the new guidelines.
165177

166178
# CLA
167179

@@ -170,6 +182,8 @@ All contributors must sign the CNCF CLA, as described [here](CLA.md).
170182
[community membership]: /community-membership.md
171183
[sig governance]: /sig-governance.md
172184
[owners]: community-membership.md#subproject-owner
173-
[short template]: committee-steering/governance/sig-charter-template.md
185+
[sig charter process]: committee-steering/governance/README.md
186+
[short template]: committee-steering/governance/sig-governance-template-short.md
187+
[kubernetes repository guidelines]: kubernetes-repositories.md
174188

175189
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/governance.md?pixel)]()

0 commit comments

Comments
 (0)