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

Add contributing.md for SIG Instrumentation for subprojects #6462

Closed
ehashman opened this issue Feb 14, 2022 · 8 comments
Closed

Add contributing.md for SIG Instrumentation for subprojects #6462

ehashman opened this issue Feb 14, 2022 · 8 comments
Labels
lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation.

Comments

@ehashman
Copy link
Member

Describe the issue

Generally the overall contributing.md works for SIG Instrumentation, but it doesn't tell folks how to get involved in our various subprojects.

@kubernetes/sig-instrumentation-members can subproject owners please take this on?

/cc @serathius
for metrics-server
/cc @fpetkovski @dgrisonnet
for KSM
/cc @pohly
for klog/logging

/sig instrumentation

@k8s-ci-robot k8s-ci-robot added the sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. label Feb 14, 2022
@serathius
Copy link
Contributor

How this should differ than already existing CONTRIBUTING.md within subprojects? (for example https://github.com/kubernetes-sigs/metrics-server/blob/master/CONTRIBUTING.md)

@dashpole
Copy link
Contributor

Should we just make sure we link to the existing contributing docs?

@serathius
Copy link
Contributor

serathius commented Feb 15, 2022

How this is different to just listing subprojects and saying to check their README.md/CONTRIBUTING.md file? In the end this will result in just becoming another list of SIGs project, which is redundant. I think it would make more sense to just encourage users to check out one of the subprojects (list is available in sig-instumentation/README.md).

Another approach to this problem that could be solved on the SIG level would be agreeing on contents of CONTRIBUTING.md in each subproject. We could have a list of required sections to maintain same level of quality. For example, they should all include:

  • Up to date Kubernetes contributing guidelines
  • List of tools required for development
  • How to run tests

@ehashman
Copy link
Member Author

ehashman commented Mar 5, 2022

@serathius right now the subprojects list just links to a bunch of OWNERS files. It's not a good starting point for newcomers to get started with contributing to subprojects. Many won't even know what an OWNERS file is.

It would be better for us to list areas seeking help and link directly to their contributor guides, which are not covered by the top-level Kubernetes one.

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue or PR as fresh with /remove-lifecycle stale
  • Mark this issue or PR as rotten with /lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/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 Jun 3, 2022
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue or PR as fresh with /remove-lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jul 3, 2022
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Reopen this issue or PR with /reopen
  • Mark this issue or PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

@k8s-ci-robot
Copy link
Contributor

@k8s-triage-robot: Closing this issue.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Reopen this issue or PR with /reopen
  • Mark this issue or PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/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
lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation.
Projects
None yet
Development

No branches or pull requests

5 participants