kubernetes / kubernetes/community

sig-node: CONTRIBUTING.md updates

Open
#6,611 4 comments 0 reactions 0 assignees View on GitHub
kind/documentation lifecycle/frozen sig/node
Dominant language
Jupyter Notebook
Stars
13k
Forks
5.4k
Avg merge
2d 17h
Merged PRs (30d)
29

Description

/sig node
/kind documentation

The sig-node contributor documentation currently assumes a lot of existing knowledge about how the kubernetes project works. To help foster new contributions from people who don't necessarily have existing upstream contributor knowledge, or people within their organization who can train them we should update this document.

I think we probably need to focus on the following as a first step:

- How do you get the code and build/test a kubelet change
- e.g you likely need access to a linux machine/vm with containerd or cri-o installed, might not be obvious to a new contrib.
- How do you make a good first contribution
- How do you find issues?
- How do you request feedback?

Something to think about in a future community meeting would be talking about how we can help foster these contributions. Reviewer/Approver capacity is low, but we can't fix that without new contributors long term.

Contributor guide

Open the contributing guide

Research direction

Update the sig-node CONTRIBUTING.md documentation, starting with the requested guidance for getting the code and building/testing a kubelet change. Cover finding issues and requesting feedback, including the Linux machine or VM and containerd or CRI-O context mentioned in the issue. Done means new contributors can follow these steps without existing upstream Kubernetes knowledge.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.