Community: Require all k/* repositories to have CONTRIBUTING.md

[guineveresaenger]

All K8s subrepositories should have a CONTRIBUTING.md file, which at the minimum should point to
https://github.com/kubernetes/community/blob/master/contributors/guide/README.md. Care should be taken that all information is in sync with the contributor guide.

Subrepositories may also have contributing guidelines specific to that repository. They should be explicitly documented and explained in the CONTRIBUTING.md.

The first step to working on this issue is to create a task list of k/subrepositories that need to have issues/PRs filed against to rectify this.

/sig contributor-experience
/area contributor-guide
/help

[k8s-ci-robot]

@guineveresaenger:
This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

All K8s subrepositories should have a CONTRIBUTING.md file, which at the minimum should point to
https://github.com/kubernetes/community/blob/master/contributors/guide/README.md. Care should be taken that all information is in sync with the contributor guide.

Subrepositories may also have contributing guidelines specific to that repository. They should be explicitly documented and explained in the CONTRIBUTING.md.

The first step to working on this issue is to create a task list of k/subrepositories that need to have issues/PRs filed against to rectify this.

/sig contributor-experience
/area contributor-guide
/help

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.

[chris-short]

Here are the following k/subrepositories with no CONTRIBUTING.md in their root dirs:

autoscaler
cloud-provider-aws
cloud-provider-azure
cloud-provider-gcp
cloud-provider-openstack
common
dashboard
examples
features
federation
gengo
kube-openapi
kube-state-metrics
kubernetes-anywhere
kubernetes-bootcamp
node-problem-detector
publishing-bot
repo-infra
sig-release
utils

[nikhita]

@guineveresaenger Could this be a good first issue as well? :)

The approach I see here is:

1. Go to each repo (from @chris-short's list above) and create an issue about adding a CONTRIBUTING.md to their repo. Mention that they can point to https://github.com/kubernetes/community/blob/master/contributors/guide/README.md if they don't want to include any specific contributing guidelines.
2. If the maintainers of the repo decide not to create specific contributing guidelines, perhaps even send a PR creating a CONTRIBUTING.md which has a link to https://github.com/kubernetes/community/blob/master/contributors/guide/README.md.

[guineveresaenger]

I think this is an excellent first issue!
/good-first-issue

[k8s-ci-robot]

@guineveresaenger:
This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

I think this is an excellent first issue!
/good-first-issue

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.

[aojea]

@nikhita @guineveresaenger I can help with this, also it is easy to automate with hub

For reference I paste my script to create all the issues

# Clone all kubernetes ORG repositories
curl -s https://api.github.com/orgs/kubernetes/repos\?per_page\=200 | grep clone_url | awk -F '"' '{print $4}' | xargs -n 1 -P 4 git clone

# Find repositories missing CONTRIBUTING.md and create issue
for i in *; do test -f $i/CONTRIBUTING.md || (cd $i; hub issue create -f ../issue1832.txt) ; done

and this is the list with the opened issues
https://github.com/kubernetes/cloud-provider-aws/issues/5 https://github.com/kubernetes/cloud-provider-azure/issues/40 https://github.com/kubernetes/cloud-provider-gcp/issues/33 https://github.com/kubernetes/cloud-provider-openstack/issues/230 https://github.com/kubernetes/cloud-provider-vsphere/issues/13 https://github.com/kubernetes/common/issues/6 https://github.com/kubernetes/dashboard/issues/3145 https://github.com/kubernetes/examples/issues/251 https://github.com/kubernetes/features/issues/588 https://github.com/kubernetes/federation/issues/278 https://github.com/kubernetes/gengo/issues/118 https://github.com/kubernetes/kube-openapi/issues/91 https://github.com/kubernetes/kubernetes-anywhere/issues/543 https://github.com/kubernetes/kubernetes-bootcamp/issues/89 https://github.com/kubernetes/kube-state-metrics/issues/494 https://github.com/kubernetes/node-problem-detector/issues/190 https://github.com/kubernetes/publishing-bot/issues/72 https://github.com/kubernetes/release/issues/585 https://github.com/kubernetes/repo-infra/issues/77 https://github.com/kubernetes/utils/issues/40

[nikhita]

@aojea THIS. IS. AWESOME. :heart:

[parispittman]

Yes, @aojea - thank you! If you are on the Kubernetes slack, DM me so we can coordinate a swag delivery. :)

[roycaihw]

Thanks for improving the contributor experience. I just want to point out that we also have client libraries under https://github.com/kubernetes-client, and project incubators under https://github.com/kubernetes-incubator. Do they also need to have CONTRIBUTING.md? AFAIK some of them don't have the file now.

[nikhita]

I just want to point out that we also have client libraries under https://github.com/kubernetes-client, and project incubators under https://github.com/kubernetes-incubator. Do they also need to have CONTRIBUTING.md? AFAIK some of them don't have the file now.

@roycaihw thanks for pointing that out! IMO they should have CONTRIBUTING.md files as well since they are official Kubernetes repos. I'll create PRs for them. :+1:

[guineveresaenger]

This is fantastic, @aojea! Thank you so much!!!

[guineveresaenger]

There are some missing ones in kubernetes-sigs as well. I'll add those.

[justaugustus]

There's some prior art from @jessfraz as well to handle SECURITY_CONTACTS: https://github.com/jessfraz/secping

We should consider using that and expanding the scope to handle all of the expected files for a k8s repo.

ref: https://groups.google.com/d/topic/kubernetes-sig-contribex/KqEXr5bVGDk/discussion

[guineveresaenger]

@justaugustus thank you for linking to that <3

[justaugustus]

Also, we should /assign if someone is officially taking up this effort.

[nikhita]

Also, we should /assign if someone is officially taking up this effort.

/assign
Assigning myself because I've created PRs against repos against the kubernetes org. Have created some more in kubernetes-client (some more are remaining, which I'll do today). All PRs reference this issue and can be seen above.

I'll also send PRs to kubernetes-incubator, unless someone gets to it sooner.

There are some missing ones in kubernetes-sigs as well. I'll add those.

/assign @guineveresaenger

[fejta-bot]

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-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[nikhita]

This issue is being tracked in steering (https://github.com/kubernetes/steering/issues/28) and has more discussion there. I'll close this issue here. Please reopen if needed.

/close

[k8s-ci-robot]

@nikhita: Closing this issue.

In response to this:

This issue is being tracked in steering (https://github.com/kubernetes/steering/issues/28) and has more discussion there. I'll close this issue here. Please reopen if needed.

/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.