Skip to content

Commit 14664b9

Browse files
authored
Merge pull request #5523 from neolit123/1.21-add-sig-cl-contributing
sig-cluster-lifecycle: add CONTRIBUTING.md
2 parents a7254a4 + 808676a commit 14664b9

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

sig-cluster-lifecycle/CONTRIBUTING.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Contributing
2+
3+
Welcome to the Kubernetes SIG Cluster Lifecycle contributing guide. We are excited
4+
about the prospect of you joining our [community](https://git.k8s.io/community/sig-cluster-lifecycle/)!
5+
6+
## Before You Begin
7+
8+
We strongly recommend you to understand the main
9+
[Kubernetes Contributor Guide](http://git.k8s.io/community/contributors/guide)
10+
and adhere to the contribution rules (specially signing the CLA).
11+
12+
You can also check the [Contributor Cheat Sheet](/contributors/guide/contributor-cheatsheet/),
13+
with common resources for existing developers.
14+
15+
Please be aware that all contributions to Kubernetes projects require time and commitment
16+
from project maintainers to direct and review work. This is done in additional to many other
17+
maintainer responsibilities, and direct engagement from maintainers is a finite resource.
18+
19+
## SIG Cluster Lifecycle explained
20+
21+
Read the SIG mission outlined in the SIG [charter][https://git.k8s.io/community/sig-cluster-lifecycle/charter.md].
22+
23+
Video resources:
24+
- [SIG introduction at KubeCon NA 2020](https://www.youtube.com/watch?v=qi-X-Wszetc)
25+
- [Slides](https://docs.google.com/presentation/d/18I1YvBUegWegc7oBJiLLxwA2I1c9VVjH)
26+
- [SIG contributor onboarding](https://www.youtube.com/watch?v=Bof9aveB3rA)
27+
28+
## Get in touch with the SIG
29+
30+
Find the SIG contact details in its [community page](http://git.k8s.io/community/sig-cluster-lifecycle/README.md#contact):
31+
- Join the SIG [mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-cluster-lifecycle)
32+
- Join the SIG [slack channel](https://kubernetes.slack.com/messages/sig-cluster-lifecycle)
33+
- Join the periodic SIG [video call](http://git.k8s.io/community/sig-cluster-lifecycle/README.md#meetings)
34+
35+
Using the SIG mailing list or video call is preferred for wider discussion topics that affect
36+
multiple subprojects. The main SIG slack channel should only be used for SIG level updates
37+
and more urgent matters.
38+
39+
Note that individual subprojects have their own slack channels and video calls (see bellow).
40+
41+
## Picking a subproject to contribute to
42+
43+
Some subprojects like kubeadm and etcdadm are lower in the stack (operate on the host machine),
44+
while other subprojects like Cluster API and kops are higher in the stack and also manage
45+
host machine provisioning and cloud provider setup. A good starting point for contributions
46+
can be a project that you have used already or have plans using in the future.
47+
48+
See the [list of subprojects](https://git.k8s.io/community/sig-cluster-lifecycle/README.md#subprojects)
49+
the SIG maintains and pick a project you wish to work on.
50+
51+
Note that individual subprojects follow different process in terms of:
52+
- Release cycle
53+
- Issue triage
54+
- Implementing features
55+
- Change submissions
56+
- Meeting format
57+
58+
Join the subproject video call and slack channel and introduce your self.
59+
60+
Navigate to the subproject repository:
61+
- Read their `README.md` file to understand what the project is about
62+
- Read their `CONTRIBUTING.md` file if you wish to contribute
63+
- See who the maintainers of the project are in the `OWNERS` file
64+
- Find issues labeled with `good-first-issue` and `help-wanted`
65+
- If you wish to work on an issue, `@` mention the issue author and `/assign @your-self`
66+
- Once you have started the work, label the issue with `/lifecycle active`
67+
- Coordinate with the subproject maintainers the submission of changes
68+
- Provide updates on your work in the subproject video call / slack channel

0 commit comments

Comments
 (0)