Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Require all k/* repositories to have CONTRIBUTING.md #1832

Closed
guineveresaenger opened this issue Feb 21, 2018 · 19 comments
Closed

Require all k/* repositories to have CONTRIBUTING.md #1832

guineveresaenger opened this issue Feb 21, 2018 · 19 comments
Assignees
Labels
area/contributor-guide Issues or PRs related to the contributor guide good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience.

Comments

@guineveresaenger
Copy link
Contributor

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
Copy link
Contributor

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

@k8s-ci-robot k8s-ci-robot added help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. area/contributor-guide Issues or PRs related to the contributor guide labels Feb 21, 2018
@chris-short
Copy link
Contributor

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
Copy link
Member

nikhita commented Jun 13, 2018

@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
Copy link
Contributor Author

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

@k8s-ci-robot
Copy link
Contributor

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

@k8s-ci-robot k8s-ci-robot added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Jun 14, 2018
@fejta-bot
Copy link

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

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 19, 2018
@nikhita
Copy link
Member

nikhita commented Oct 19, 2018

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

/close

@k8s-ci-robot
Copy link
Contributor

@nikhita: Closing this issue.

In response to this:

This issue is being tracked in steering (kubernetes/steering#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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/contributor-guide Issues or PRs related to the contributor guide good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience.
Projects
None yet
Development

No branches or pull requests

9 participants