github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-20 10:20:51 +00:00
Code Issues Projects Releases Wiki Activity

staging-readme: Document the need to add doc.go in a staging repo

Browse Source 
Signed-off-by: Swati Sehgal <swsehgal@redhat.com>
This commit is contained in:
Swati Sehgal 2022-06-16 13:48:13 +01:00
parent 10c37c5942
commit 22ff20a0a0
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
staging/README.md
View File

@ -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/<newrepo>/) 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)