Skip to content

Commit 48112c0

Browse files
committed
update sig-node contributing doc
1 parent f7551d8 commit 48112c0

File tree

2 files changed

+153
-100
lines changed

2 files changed

+153
-100
lines changed

sig-node/CONTRIBUTING.md

Lines changed: 53 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,68 +4,96 @@ Welcome!
44

55
## For Kubernetes Contributions
66

7-
https://github.com/kubernetes/community/tree/master/contributors/guide#contributor-guide
7+
Read the [Kubernetes Contributor Guide](https://github.com/kubernetes/community/tree/master/contributors/guide#contributor-guide).
88

99
If you aspire to grow scope in the SIG, please review the [SIG Node contributor ladder](./sig-node-contributor-ladder.md) for SIG specific guidance.
1010

11-
### For Enhancements
11+
### For Enhancements
1212

13-
https://github.com/kubernetes/enhancements/tree/master/keps/sig-node
13+
SIG Node enhancements are available in the <https://github.com/kubernetes/enhancements/tree/master/keps/sig-node>.
1414

1515
#### Helpful Links for Sig-Node
1616

17-
Code:
17+
**Code**:
1818

19-
https://github.com/kubernetes/kubernetes/tree/master/cmd/kubelet
19+
For general code organization, read [contributors/devel/README.md](contributors/devel/README.md) for explaning things like
20+
`vendor/`, `staging`, etc.
2021

21-
https://github.com/kubernetes/kubernetes/tree/master/pkg/kubelet
22+
* Kubelet
23+
* <https://github.com/kubernetes/kubernetes/tree/master/cmd/kubelet>
24+
* <https://github.com/kubernetes/kubernetes/tree/master/pkg/kubelet>
25+
* Probe: <https://github.com/kubernetes/kubernetes/tree/master/pkg/probe>
26+
* NodeLifecycle: <https://github.com/kubernetes/kubernetes/tree/master/pkg/controller/nodelifecycle>
27+
* Node API: <https://github.com/kubernetes/kubernetes/tree/master/staging/src/k8s.io/api/node>
28+
* CRI API: <https://github.com/kubernetes/kubernetes/tree/master/staging/src/k8s.io/cri-api>
29+
* DRA:
30+
* <https://github.com/kubernetes/kubernetes/tree/master/staging/src/k8s.io/dynamic-resource-allocation>
31+
* <https://github.com/kubernetes/kubernetes/tree/master/staging/src/k8s.io/kubelet/pkg/apis/dra/>
32+
* <https://github.com/kubernetes/kubernetes/tree/master/test/e2e/dra/>
33+
* E2E test:
34+
* <https://github.com/kubernetes/kubernetes/tree/master/test/e2e/node/>
35+
* <https://github.com/kubernetes/kubernetes/tree/master/test/e2e_node/>
36+
* CI (test-infra)
37+
* [sig-node jobs](https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes/sig-node/)
38+
* [e2e_node jobs](<https://github.com/kubernetes/test-infra/blob/master/jobs/e2e_node/>
39+
* [sig-node test-grids](https://github.com/kubernetes/test-infra/blob/master/config/testgrids/kubernetes/sig-node/)
40+
* [containerd test-grids](https://github.com/kubernetes/test-infra/blob/master/config/testgrids/kubernetes/containerd/)
2241

23-
https://github.com/kubernetes/kubernetes/tree/master/pkg/probe
42+
**Development Resources**:
2443

25-
Development Resources:
44+
* <https://github.com/kubernetes/community/tree/master/contributors/devel#table-of-contents>
2645

27-
https://github.com/kubernetes/community/tree/master/contributors/devel#table-of-contents
46+
There are two types of end-to-end tests in Kubernetes:
2847

29-
Shared space / Sub projects:
48+
* [Cluster end-to-end tests](https://git.k8s.io/community/contributors/devel/sig-testing/e2e-tests.md)
49+
* [Node end-to-end tests](https://git.k8s.io/community/contributors/devel/sig-node/e2e-node-tests.md)
3050

31-
https://github.com/kubernetes/community/tree/master/contributors/devel/sig-node
51+
**Shared space / Sub projects**:
3252

33-
https://github.com/kubernetes/community/tree/master/sig-node#subprojects
53+
* <https://github.com/kubernetes/community/tree/master/contributors/devel/sig-node>
54+
* <https://github.com/kubernetes/community/tree/master/sig-node#subprojects>
3455

35-
Triage:
36-
https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/triage.md
56+
**Triage**:
57+
58+
* <https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/triage.md>
59+
60+
**Test Grids**:
61+
62+
* SIG Node overview: <https://testgrid.k8s.io/sig-node>
63+
* Release Blocking: <https://testgrid.k8s.io/sig-node-release-blocking>
64+
* Kubelet: <https://testgrid.k8s.io/sig-node-kubelet>
65+
* Containerd: <https://testgrid.k8s.io/sig-node-containerd>
3766

3867
## Getting Started
3968

4069
Task #1 : Compile kubelet
41-
See tips in the root Makefile
42-
43-
https://github.com/kubernetes/community/blob/master/contributors/devel/development.md#building-kubernetes
70+
See tips in the root Makefile:
71+
72+
* <https://github.com/kubernetes/community/blob/master/contributors/devel/development.md#building-kubernetes>
4473

4574
Task #2 : Run a single unit test
4675

47-
https://github.com/kubernetes/community/blob/master/contributors/devel/development.md#unit-tests
76+
* <https://github.com/kubernetes/community/blob/master/contributors/devel/development.md#unit-tests>
4877

4978
Task #3 : Explore update/verify scripts
5079

5180
hack/update-gofmt.sh + hack/verify-gofmt.sh
5281

53-
https://github.com/kubernetes/kubernetes/blob/master/hack/update-gofmt.sh
54-
55-
https://github.com/kubernetes/kubernetes/blob/master/hack/verify-gofmt.sh
82+
* <https://github.com/kubernetes/kubernetes/blob/master/hack/update-gofmt.sh>
83+
* <https://github.com/kubernetes/kubernetes/blob/master/hack/verify-gofmt.sh>
5684

5785
Task #4 : Explore dependencies
5886

5987
hack/pin-dependency.sh + hack/update-vendor.sh
6088

61-
https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/vendor.md
89+
* <https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/vendor.md>
6290

6391
Task #5 : Using local-up-cluster script
6492

65-
https://github.com/kubernetes/community/blob/master/contributors/devel/running-locally.md#starting-the-cluster
93+
* <https://github.com/kubernetes/community/blob/master/contributors/devel/running-locally.md#starting-the-cluster>
6694

6795
Running a local cluster
6896

69-
https://github.com/kubernetes/community/blob/master/contributors/devel/running-locally.md
70-
97+
* <https://github.com/kubernetes/community/blob/master/contributors/devel/running-locally.md>
98+
7199
Note: Task 5 requires Linux OS

0 commit comments

Comments
 (0)