Skip to content

Commit ca0ca53

Browse files
authored
Merge pull request #5713 from EmilyM1/contributor-guide-sig-node
add contributing guide for sig-node
2 parents 5649b83 + 8086c41 commit ca0ca53

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

sig-node/CONTRIBUTING.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Contributing on SIG Node
2+
3+
Welcome!
4+
5+
## For Kubernetes Contributions
6+
7+
https://github.com/kubernetes/community/tree/master/contributors/guide#contributor-guide
8+
9+
### For Enhancements
10+
11+
https://github.com/kubernetes/enhancements/tree/master/keps/sig-node
12+
13+
#### Helpful Links for Sig-Node
14+
15+
Code:
16+
17+
https://github.com/kubernetes/kubernetes/tree/master/cmd/kubelet
18+
19+
https://github.com/kubernetes/kubernetes/tree/master/pkg/kubelet
20+
21+
https://github.com/kubernetes/kuberentes/tree/master/pkg/probe
22+
23+
Development Resources:
24+
25+
https://github.com/kubernetes/community/tree/master/contributors/devel#table-of-contents
26+
27+
Shared space / Sub projects:
28+
29+
https://github.com/kubernetes/community/tree/master/contributors/devel/sig-node
30+
31+
https://github.com/kubernetes/community/tree/master/sig-node#subprojects
32+
33+
Triage:
34+
https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/triage.md
35+
36+
37+
## Getting Started
38+
39+
Task #1 : Compile kubelet
40+
See tips in the root Makefile
41+
42+
https://github.com/kubernetes/community/blob/master/contributors/devel/development.md#building-kubernetes
43+
44+
Task #2 : Run a single unit test
45+
46+
https://github.com/kubernetes/community/blob/master/contributors/devel/development.md#unit-tests
47+
48+
Task #3 : Explore update/verify scripts
49+
50+
hack/update-gofmt.sh + hack/verify-gofmt.sh
51+
52+
https://github.com/kubernetes/kubernetes/blob/master/hack/update-gofmt.sh
53+
54+
https://github.com/kubernetes/kubernetes/blob/master/hack/verify-gofmt.sh
55+
56+
Task #4 : Explore dependencies
57+
58+
hack/pin-dependency.sh + hack/update-vendor.sh
59+
60+
https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/vendor.md
61+
62+
Task #5 : Using local-up-cluster script
63+
64+
https://github.com/kubernetes/community/blob/master/contributors/devel/running-locally.md#starting-the-cluster
65+
66+
Running a local cluster
67+
68+
https://github.com/kubernetes/community/blob/master/contributors/devel/running-locally.md
69+
70+
Note: Task 5 requires Linux OS

0 commit comments

Comments
 (0)