Skip to content

Commit

Permalink
add contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
EmilyM1 committed Apr 23, 2021
1 parent 1dc8ae4 commit 8086c41
Showing 1 changed file with 70 additions and 0 deletions.
70 changes: 70 additions & 0 deletions sig-node/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Contributing on SIG Node

Welcome!

## For Kubernetes Contributions

https://github.com/kubernetes/community/tree/master/contributors/guide#contributor-guide

### For Enhancements

https://github.com/kubernetes/enhancements/tree/master/keps/sig-node

#### Helpful Links for Sig-Node

Code:

https://github.com/kubernetes/kubernetes/tree/master/cmd/kubelet

https://github.com/kubernetes/kubernetes/tree/master/pkg/kubelet

https://github.com/kubernetes/kuberentes/tree/master/pkg/probe

Development Resources:

https://github.com/kubernetes/community/tree/master/contributors/devel#table-of-contents

Shared space / Sub projects:

https://github.com/kubernetes/community/tree/master/contributors/devel/sig-node

https://github.com/kubernetes/community/tree/master/sig-node#subprojects

Triage:
https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/triage.md


## Getting Started

Task #1 : Compile kubelet
See tips in the root Makefile

https://github.com/kubernetes/community/blob/master/contributors/devel/development.md#building-kubernetes

Task #2 : Run a single unit test

https://github.com/kubernetes/community/blob/master/contributors/devel/development.md#unit-tests

Task #3 : Explore update/verify scripts

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

https://github.com/kubernetes/kubernetes/blob/master/hack/update-gofmt.sh

https://github.com/kubernetes/kubernetes/blob/master/hack/verify-gofmt.sh

Task #4 : Explore dependencies

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

https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/vendor.md

Task #5 : Using local-up-cluster script

https://github.com/kubernetes/community/blob/master/contributors/devel/running-locally.md#starting-the-cluster

Running a local cluster

https://github.com/kubernetes/community/blob/master/contributors/devel/running-locally.md

Note: Task 5 requires Linux OS

0 comments on commit 8086c41

Please sign in to comment.