Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Add documentation to the code #64

Closed
courtneypacheco opened this issue Apr 29, 2021 · 8 comments
Closed

Add documentation to the code #64

courtneypacheco opened this issue Apr 29, 2021 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature.

Comments

@courtneypacheco
Copy link
Contributor

What would you like to be added:
Documentation for the code

Why is this needed:
I would like to contribute to this codebase, but I am not familiar with any of the NFD code right now. So, I'm going to have to ramp up and learn how everything works, but I figure that if I'm going to learn the codebase, I might as well update the documentation by adding comments to functions, etc in the process. Then new users who want to contribute to this codebase will be able to ramp up quickly, which will hopefully encourage more people to contribute to this repo.

Thoughts?

@courtneypacheco courtneypacheco added the kind/feature Categorizes issue or PR as related to a new feature. label Apr 29, 2021
@ArangoGutierrez
Copy link
Contributor

/assign @courtneypacheco

@ArangoGutierrez ArangoGutierrez added documentation Improvements or additions to documentation good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Apr 29, 2021
@marquiz
Copy link
Contributor

marquiz commented Apr 30, 2021

Welcome @courtneypacheco! I think improving/adding docstrings and adding comments where you find the code hard to follow is very much appreciated

@k8s-triage-robot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 29, 2021
@ArangoGutierrez
Copy link
Contributor

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 11, 2021
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue or PR as fresh with /remove-lifecycle stale
  • Mark this issue or PR as rotten with /lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 9, 2021
@vaibhav2107
Copy link
Contributor

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 24, 2021
@marquiz
Copy link
Contributor

marquiz commented Jan 20, 2022

Fixed by #87, I'd say
/close

@k8s-ci-robot
Copy link
Contributor

@marquiz: Closing this issue.

In response to this:

Fixed by #87, I'd say
/close

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

No branches or pull requests

6 participants