-
Notifications
You must be signed in to change notification settings - Fork 42.1k
Labels
area/code-organizationIssues or PRs related to kubernetes code organizationIssues or PRs related to kubernetes code organizationgood first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.Denotes an issue ready for a new contributor, according to the "help wanted" guidelines.help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.sig/architectureCategorizes an issue or PR as relevant to SIG Architecture.Categorizes an issue or PR as relevant to SIG Architecture.
Description
- Look at one of the directories under staging/src/k8s.io/ (Please don't pick more than one directory for one PR as it will cause issues for reviewers)
- Find all the files named
doc.go(example find staging/src/k8s.io/client-go/ -name doc.go) - See the following link it has a
// import "k8s.io/client-go/tools/remotecommand"this tells tools how this package needs to be imported. So we should ensure that each doc.go has an import
package remotecommand // import "k8s.io/client-go/tools/remotecommand" - Add a description appropriate to the package (similar to the one below)
kubernetes/staging/src/k8s.io/client-go/tools/remotecommand/doc.go
Lines 17 to 19 in 1fc36a5
// Package remotecommand adds support for executing commands in containers, // with support for separate stdin, stdout, and stderr streams, as well as // TTY. - Look through sub directories and see if there are any other important directories that are likely to be used by outside users and add a doc.go
Why are we doing this?
- We perfer to use vanity urls instead of directly using github.com to refer to code, so this helps ensure that tools honor our wish. See https://golang.org/doc/go1.4#canonicalimports
- It would be good to have some package level documentation since these directories under staging/ are meant to be for use by folks outside of kubernetes github org.
/good-first-issue
nikhita, seriousdevelopers, mysunshine92, vsamidurai, alejandrox1 and 1 more
Metadata
Metadata
Assignees
Labels
area/code-organizationIssues or PRs related to kubernetes code organizationIssues or PRs related to kubernetes code organizationgood first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.Denotes an issue ready for a new contributor, according to the "help wanted" guidelines.help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.sig/architectureCategorizes an issue or PR as relevant to SIG Architecture.Categorizes an issue or PR as relevant to SIG Architecture.