-
Notifications
You must be signed in to change notification settings - Fork 32
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
Comments
/assign @courtneypacheco |
Welcome @courtneypacheco! I think improving/adding docstrings and adding comments where you find the code hard to follow is very much appreciated |
Issues go stale after 90d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-contributor-experience at kubernetes/community. |
/remove-lifecycle stale |
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:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
/remove-lifecycle stale |
Fixed by #87, I'd say |
@marquiz: Closing this issue. In response to this:
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. |
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?
The text was updated successfully, but these errors were encountered: