Ensure all kubernetes repos follow the same contributing structure

[caniszczyk]

Some CNCF members have higher maintenance legal departments and require a bit more documentation in repos regarding contributing criteria. For example, there is the Kubernetes Contributor Guide that mandates that the CNCF CLA be signed and seems to apply to all code, but has a big disclaimer at the top which makes some legal departments wary. Some of the repo’s have a CONTRIBUTING.md file with a clear process which is good, others point to the Contributor Guide which is okay but many others have no such file – for example:

https://github.com/kubernetes/apiserver
https://github.com/kubernetes/cloud-provider-aws
https://github.com/kubernetes/cloud-provider-gcp
https://github.com/kubernetes/cloud-provider-openstack
https://github.com/kubernetes/common
https://github.com/kubernetes/dashboard
https://github.com/kubernetes/examples
https://github.com/kubernetes/federation
https://github.com/kubernetes/gengo
https://github.com/kubernetes/kube-openapi
https://github.com/kubernetes/kube-state-metrics
https://github.com/kubernetes/kubernetes-anywhere
https://github.com/kubernetes/kubernetes-bootcamp
https://github.com/kubernetes/node-problem-detector
https://github.com/kubernetes/publishing-bot
https://github.com/kubernetes/release
https://github.com/kubernetes/repo-infra
https://github.com/kubernetes/test-infra
https://github.com/kubernetes/utils

Can we ensure that every proper Kubernetes project has a CONTRIBUTING.md with terms clearly spelled out?

[cblecker]

@kubernetes/sig-contributor-experience-proposals @kubernetes/steering-committee

[philips]

I don't see any reason to not just ensure CONTRIBUTING.md is copied from https://github.com/kubernetes/kubernetes-template-project

Any opposition? If not I will file the issues across the repos.

Hey @jessfraz can you recommend a tool for filing issues like you did with #30

[cblecker]

cc @spiffxp who has also done many-repo issue/PR creation

[jessfraz]

It's just part of the tool I made for it. Opens an issue if an issue doesn't already exist and the file doesn't exist... https://github.com/jessfraz/secping Super hacky buyer beware.

[philips]

@jessfraz Great! I think I am going to just write a tool to ensure everyone's projects match the template project based on your code. :)

[philips]

For example, there is the Kubernetes Contributor Guide that mandates that the CNCF CLA be signed and seems to apply to all code, but has a big disclaimer at the top which makes some legal departments wary.

@caniszczyk Where is the above happening? I don't know exactly what you are talking about.

[philips]

I think largely this is an issue that @kubernetes/sig-contributor-experience-feature-requests needs to handle. Posted it over on their mailing list https://groups.google.com/forum/#!topic/kubernetes-sig-contribex/KqEXr5bVGDk

Happy to help though!

[jessfraz]

I can make the tool, would be super fast since it can use the same code :)

…

On Thu, Jul 5, 2018 at 9:31 PM Brandon Philips ***@***.***> wrote: I think largely this is an issue that @kubernetes/sig-contributor-experience-feature-requests <https://github.com/orgs/kubernetes/teams/sig-contributor-experience-feature-requests> needs to handle. Posted it over on their mailing list https://groups.google.com/forum/#!topic/kubernetes-sig-contribex/KqEXr5bVGDk Happy to help though! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#28 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABYNbDuTVUZ6RoDMq5xSvNv5HAsKeMPWks5uDr3igaJpZM4Ta-I2> .

-- Jessie Frazelle 4096R / D4C4 DD60 0D66 F65A 8EFC 511E 18F3 685C 0022 BFF3 pgp.mit.edu <http://pgp.mit.edu/pks/lookup?op=get&search=0x18F3685C0022BFF3>

[philips]

If you have time go for it! The only real change from the secping will be some of the files need to be more or less exact (LICENSE?) And in others just in the right format (OWNERs)

…

On Fri, Jul 6, 2018, 7:33 AM Jess Frazelle ***@***.***> wrote: I can make the tool, would be super fast since it can use the same code :) On Thu, Jul 5, 2018 at 9:31 PM Brandon Philips ***@***.***> wrote: > I think largely this is an issue that > @kubernetes/sig-contributor-experience-feature-requests > < https://github.com/orgs/kubernetes/teams/sig-contributor-experience-feature-requests > > needs to handle. Posted it over on their mailing list > https://groups.google.com/forum/#!topic/kubernetes-sig-contribex/KqEXr5bVGDk > > Happy to help though! > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <#28 (comment) >, > or mute the thread > < https://github.com/notifications/unsubscribe-auth/ABYNbDuTVUZ6RoDMq5xSvNv5HAsKeMPWks5uDr3igaJpZM4Ta-I2 > > . > -- Jessie Frazelle 4096R / D4C4 DD60 0D66 F65A 8EFC 511E 18F3 685C 0022 BFF3 pgp.mit.edu < http://pgp.mit.edu/pks/lookup?op=get&search=0x18F3685C0022BFF3> — You are receiving this because you were assigned. Reply to this email directly, view it on GitHub <#28 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AACDCNRK8bxUg--Fitpah9-RL_nsOKjeks5uD3UPgaJpZM4Ta-I2> .

[castrojo]

@caniszczyk The contributor guide has had enough people go through it that we can safely drop the disclaimer. I'd be happy to add whatever language you feel would make it more authoritative so that we can just safely point to it from all the repos.

[spiffxp]

/assign
I agree implementation of this basically falls to other SIG's. I'll confirm whether or not we have an appropriate CONTRIBUTING.md in place everywhere. I noticed @nikhita has been helping out with this as well.

Related: moving all repos to use the same automation for code review and merging: kubernetes/test-infra#6227

[spiffxp]

The following repos currently lack a CONTRIBUTING.md:

• kubernetes-csi/csi-test
• kubernetes-csi/docs
• kubernetes-csi/driver-registrar
• kubernetes-csi/drivers
• kubernetes-csi/external-attacher
• kubernetes-csi/external-provisioner
• kubernetes-csi/external-snapshotter
• kubernetes-csi/kubernetes-csi.github.io
• kubernetes-csi/livenessprobe
• kubernetes-incubator/apiserver-builder
• kubernetes-incubator/cluster-capacity
• kubernetes-incubator/descheduler
• kubernetes-incubator/reference-docs
• kubernetes-sigs/architecture-tracking
• kubernetes-sigs/kube-storage-version-migrator
• kubernetes-sigs/kustomize
• kubernetes/federation

[nikhita]

xref kubernetes/community#1832

[philips]

FWIW, I have noticed GitHub running an experiment that rolls the file list up when it is long.

…

On Sat, Sep 1, 2018 at 7:35 PM Jeff Regan ***@***.***> wrote: It's preferable to put CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY_CONTACTS.md and other boilerplate into a docs subdirectory. There's precedent <https://help.github.com/articles/setting-guidelines-for-repository-contributors/> for this. That way it's not "above the fold" in the unfortunate github repo UX. The more files in root, the further down goes the immediately valuable content of README.md. Let's allow (via policy and tooling - please @jessfraz <https://github.com/jessfraz> ) placing these files in docs *or* root. — You are receiving this because you were assigned. Reply to this email directly, view it on GitHub <#28 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AACDCKCkQ8asWceJlmNXOA4RQnaPGs0Mks5uW0PigaJpZM4Ta-I2> .

[monopole]

if you notice a URL parameter for that github UX experiment, please post it :)

meanwhile scroll scroll scroll https://github.com/kubernetes/kubernetes

[BenTheElder]

It's being a/b tested I think, I've seen it a few times. With it "the fold" is a relatively short max length and the directories are scrollboxed above the README. Who knows if they'll actually make that change though.

If we can agree on the policy, the tooling changes to match should be straight forward. I'd hope we can standardize as much as possible though, Kubernetes and all of its projects are already a lot to wade through ...

[spiffxp]

Every repo in the kubernetes project now uses prow+tide for review and merge automation. There are some minor differences around whether /approve is implicitly added, and whether tide squashes or merges. But mostly everything is the same.

So now this is just a matter of vetting whether all the right docs are in the right places. And agreeing on where we want those right places to be.

[monopole]

My comment should not be taken as blocking.
E.g. we've put all these docs at the top level in https://github.com/kubernetes-sigs/kustomize

[pwittrock]

@nikhita FYI

[nikhita]

@monopole @pwittrock Ack. 👍 It is not blocked on kustomize (thanks for sorting it out!).

I'm waiting on someone from csi owners to approve kubernetes-csi/kubernetes-csi.github.io#4 (comment) so that we can close this.

[nikhita]

Oh we should also run a script to check if all repos have CONTRIBUTING.md before closing this. Afaik the newer repos have it, but would be good to double check.

(I am happy to hunt this down after KubeCon)

[BenTheElder]

FWIW I am always trying to minimize what is in the repo root, if we had thought of this earlier docs/ would have been nice for most of these.

…

On Wed, Dec 5, 2018 at 10:26 PM Nikhita Raghunath ***@***.***> wrote: Oh we should also run a script to check if all repos have CONTRIBUTING.md before closing this. Afaik the newer repos have it, but would be good to double check. (I am happy to hunt this down after KubeCon) — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#28 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA4Bq8kh2lLcBInzAPqSf48WUSKjkhS0ks5u2LiHgaJpZM4Ta-I2> .

[nikhita]

I put together some quick Go code to list repos not having the CONTRIBUTING.md file and this is the list right now:

kubernetes:
kubernetes/dashboard
kubernetes/federation
kubernetes/cloud-provider-alibaba-cloud
kubernetes/cloud-provider-sample

kubernetes-sigs:
kubernetes-sigs/aws-alb-ingress-controller
kubernetes-sigs/mutating-trace-admission-controller

I have created PRs for all of these repos and will report back when they are merged. All PRs are referenced/linked above.
/assign

[nikhita]

Fyi I used the same tool to identify repos with missing LICENSE (#57 (comment)) and CoC (kubernetes/community#3053).

Created PRs for all repos to fix this. We should look into automating this though (can discuss the automation in kubernetes/community#3053).

[philips]

Remaining repos as of 2019-01-16:

• Add CONTRIBUTING.md kubernetes-retired/federation#299

[shashidharatd]

Remaining repos as of 2019-01-16:
kubernetes-retired/federation#299

The pr is merged.

[nikhita]

Thanks, @shashidharatd! Closing this issue, let's discuss automating this in kubernetes/community#3053.

/close

[k8s-ci-robot]

@nikhita: Closing this issue.

In response to this:

Thanks, @shashidharatd! Closing this issue, let's discuss automating this in kubernetes/community#3053.

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