From 22ff20a0a06b3d22c40269ced3903d5f6ef22aa0 Mon Sep 17 00:00:00 2001 From: Swati Sehgal Date: Thu, 16 Jun 2022 13:48:13 +0100 Subject: [PATCH] staging-readme: Document the need to add doc.go in a staging repo Signed-off-by: Swati Sehgal --- staging/README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/staging/README.md b/staging/README.md index 40b071bff29..37c009a98d3 100644 --- a/staging/README.md +++ b/staging/README.md @@ -79,6 +79,13 @@ https://github.com/kubernetes/kubernetes-template-project. 6. Make sure that the `.github/PULL_REQUEST_TEMPLATE.md` and `CONTRIBUTING.md` files mention that PRs are not directly accepted to the repo. +7. Ensure that `docs.go` file is added. Refer to [#kubernetes/kubernetes#91354](https://github.com/kubernetes/kubernetes/blob/release-1.24/staging/src/k8s.io/client-go/doc.go) for reference. + +8. NOTE: Do not edit go.mod or go.sum in the new repo (staging/src/k8s.io//) manually. Run the following instead: + +``` + ./hack/update-vendor.sh +``` ### Creating the published repository 1. Create an [issue](https://github.com/kubernetes/org/issues/new?template=repo-create.md)