Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[SIG Node] Improve CONTRIBUTING.md #7223

Closed
5 tasks
SergeyKanzhelev opened this issue Mar 29, 2023 · 5 comments · Fixed by #7324
Closed
5 tasks

[SIG Node] Improve CONTRIBUTING.md #7223

SergeyKanzhelev opened this issue Mar 29, 2023 · 5 comments · Fixed by #7324
Assignees
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. sig/node Categorizes an issue or PR as relevant to SIG Node.

Comments

@SergeyKanzhelev
Copy link
Member

As discussed at the SIG Node meeting today we need to improve SIG Node contributing.md file.

Some ideas:

  • Break down components beyond kubelet
  • Link to the SIG Node related test-infra folders and code
  • Links on documentation for e2e tests and e2e_node tests
  • Link to general code organization document (explaining things like vendor/, staging/, etc.)
  • Link contributors ladder sig-node-contributor-ladder.md

/sig node
/help

@k8s-ci-robot
Copy link
Contributor

@SergeyKanzhelev:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

As discussed at the SIG Node meeting today we need to improve SIG Node contributing.md file.

Some ideas:

  • Break down components beyond kubelet
  • Link to the SIG Node related test-infra folders and code
  • Links on documentation for e2e tests and e2e_node tests
  • Link to general code organization document (explaining things like vendor/, staging/, etc.)
  • Link contributors ladder sig-node-contributor-ladder.md

/sig node
/help

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added sig/node Categorizes an issue or PR as relevant to SIG Node. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Mar 29, 2023
@pacoxu
Copy link
Member

pacoxu commented Apr 4, 2023

I would like to help with this task. I was recently working on a topic like Kubelet Intro & Deep Dive.

https://github.com/kubernetes/community/blob/master/sig-node/CONTRIBUTING.md
/assign

@manishd17
Copy link

I wanna work on this issue

@pacoxu
Copy link
Member

pacoxu commented May 29, 2023

@manishd17 have you started your work on this?

I just get some time to start this work.

@manishd17
Copy link

Ok!!

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. sig/node Categorizes an issue or PR as relevant to SIG Node.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants