Ensure all kubernetes repos follow the same contributing structure about steering HOT 33 CLOSED

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

from steering.

/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

from steering.

Created PRs for the list of repos that @spiffxp mentioned. All of them are referenced above. Some of the newer repos did not contain LICENSE and CoC files so I added them as well. :)

Some of these newer repos also don't contain the SECURITY_CONTACTS files and do not have an issue for it (since they are new). We either need to run @jessfraz's tool again or have something automated to make sure that all repos contain these mandatory template files.

Will update once all the PRs are merged.

from steering.

from steering.

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

from steering.

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.

from steering.

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

from steering.

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

from steering.

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

from steering.

from steering.

@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. :)

from steering.

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.

from steering.

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!

from steering.

from steering.

from steering.

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

from steering.

xref kubernetes/community#1832

from steering.

Awesome @nikhita!

Perhaps we could set up a periodic fejta-bot job (once a week?) to scan the orgs and file these automatically with @jessfraz's secping + extend it to do LICENSE, CONTRIBUTING.md etc. ?

It looks like it would be pretty straightforward to start with setting one up for SECURITY_CONTACTS just running secping and supplying the token.

from steering.

Perhaps we could set up a periodic fejta-bot job (once a week?) to scan the orgs and file these automatically with @jessfraz's secping + extend it to do LICENSE, CONTRIBUTING.md etc. ?

Sgtm 🎉

from steering.

Filed kubernetes/test-infra#9244 to start with regularly running secping.

from steering.

It's preferable to put CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY_CONTACTS.md and other boilerplate into a docs subdirectory. There's precedent 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 ) placing these files in docs or root.

from steering.

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

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

from steering.

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

from steering.

@nikhita FYI

from steering.

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

from steering.

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)

from steering.

from steering.

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

from steering.

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

from steering.

Remaining repos as of 2019-01-16:

• kubernetes-retired/federation#299

from steering.

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

The pr is merged.

from steering.

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

/close

from steering.

@nikhita: Closing this issue.

from steering.