-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Comments
How this should differ than already existing CONTRIBUTING.md within subprojects? (for example https://github.com/kubernetes-sigs/metrics-server/blob/master/CONTRIBUTING.md) |
Should we just make sure we link to the existing contributing docs? |
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:
|
@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. |
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:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
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:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle rotten |
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:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /close |
@k8s-triage-robot: Closing this issue. In response to this:
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. |
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
The text was updated successfully, but these errors were encountered: