Add skeleton for maintainer and contributor guidebooks #2051
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
austinlparker
requested review from
alolita,
danielgblanco,
dyladan,
jpkrohling,
mtwo,
svrnm,
tedsuo and
trask
as code owners
svrnm
reviewed
Apr 15, 2024
|
|
||
| <img width="1065" alt="EasyCLA bot" src="https://user-images.githubusercontent.com/69111235/152226443-f6fe61ee-0e92-46c5-b6ea-c0deb718a585.png"> | ||
|
|
||
| #### 1. If you are signing up as a corporate contributor, ensure that you have linked your corporate email address to your GitHub profile (it doesn't have to be your primary email address for GitHub) or else it can lead to issues with the CLA system. |
There was a problem hiding this comment.
it might be worth calling out that signing up as a corporate contributor might require some internal steps that need to be completed as well, if it exists their company's OSPO is the right point of contact for that (and also the right point of contact if everything goes south with the corporate contributor license agreement, which I saw happening a few times already).
A common requirement by corporations might also be that contributions are done using the corporate email address, if wanted I can write a few words on how one can setup their git config to make sure the right email address is used.
trask
approved these changes
Apr 18, 2024
jpkrohling
approved these changes
Apr 19, 2024
cijothomas
reviewed
Apr 19, 2024
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
Co-authored-by: Severin Neumann <severin.neumann@altmuehlnet.de>
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
arminru
approved these changes
Apr 23, 2024
| ## Changing your Affiliation | ||
|
|
||
| If you've changed employers and still contribute to OpenTelemetry, your affiliation | ||
| needs to be updated. The Cloud Native Computing Foundation uses [gitdm](https://github.com/cncf/gitdm) |
There was a problem hiding this comment.
Is that used for CLA purposes too or just for the dev stats?
arminru
reviewed
Apr 23, 2024
Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com>
Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com>
Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com>
Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com>
Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com>
reyang
approved these changes
Apr 25, 2024
|
I've added a bit more here and I think I've consolidated all of the existing contributor guide stuff over into the new structure, PTAL. There's some broken links still I believe. |
svrnm
approved these changes
May 7, 2024
trask
approved these changes
May 8, 2024
|
|
||
| Specification issues are regularly triaged by the GC. The GC may accept, | ||
| decline, or defer the issue until more details are added. Once an issue is | ||
| accepted, it needs a sponsor from the TC who will be responsible for driving the |
There was a problem hiding this comment.
Suggested change
| accepted, it needs a sponsor from the TC who will be responsible for driving the | |
| accepted, it may need a sponsor from the TC who will be responsible for driving the |
JamieDanielson
approved these changes
May 14, 2024
|
|
||
| Welcome to OpenTelemetry! We're excited for you to join us. This guide will help | ||
| you get started by providing an overview of the project, how we work together, | ||
| and point you towards helpful resources. |
There was a problem hiding this comment.
Suggested change
| and point you towards helpful resources. | |
| and where to find helpful resources. |
nit
|
|
||
| OpenTelemetry is a framework for application telemetry data. If you've ever | ||
| checked how much memory a process is using on your computer, or looked at the | ||
| size of a file, you've already interacted with telemetry! Cloud-native systems |
There was a problem hiding this comment.
Suggested change
| size of a file, you've already interacted with telemetry! Cloud-native systems | |
| size of a file, you've already interacted with telemetry! Cloud native systems |
nit (ref)
| the contribution and making sure all interested parties have a chance to | ||
| object and/or contribute. The GC should work with any appropriate Special Interest | ||
| Groups or Working Groups to evaluate the donation proposal, consider alternatives, | ||
| and ensure OTel has the resources required to support the donation. When |
There was a problem hiding this comment.
Suggested change
| and ensure OTel has the resources required to support the donation. When | |
| and ensure OpenTelemetry has the resources required to support the donation. When |
nit
| 3. If a donation proposal passes the initial GC screening, the Technical Committee (TC) | ||
| will conduct due diligence to determine if the proposed donation can be effectively | ||
| integrated into the OpenTelemetry project in a way that meets the quality, security, | ||
| and privacy standards of the project without violating stable specification or OTEPs. |
There was a problem hiding this comment.
Suggested change
| and privacy standards of the project without violating stable specification or OTEPs. | |
| and privacy standards of the project without violating stable specification or OpenTelemetry Enhancement Proposals (OTEPs). |
nit
Comment on lines
+47
to
+49
| The TC will summarize their findings, and make a recommendation to either, | ||
| conditionally or unconditionally, accept or reject the proposal, in a report which will | ||
| be attached to the donation proposal issue. Writing the report may require meeting |
There was a problem hiding this comment.
Suggested change
| The TC will summarize their findings, and make a recommendation to either, | |
| conditionally or unconditionally, accept or reject the proposal, in a report which will | |
| be attached to the donation proposal issue. Writing the report may require meeting | |
| The TC will summarize their findings, and make a recommendation to either | |
| accept or reject the proposal, conditionally or unconditionally, in a report which will | |
| be attached to the donation proposal issue. Writing the report may require meeting |
slight adjustment for clarity
|
|
||
| 1. Per the above, the donating organization creates a GitHub issue using | ||
| the "Donation Proposal" form in the `community` repository. | ||
| 2. The Governance Committee (GC) will evaluate the proposal to ensure that |
There was a problem hiding this comment.
Suggested change
| 2. The Governance Committee (GC) will evaluate the proposal to ensure that | |
| 2. The GC will evaluate the proposal to ensure that |
for consistency we can use GC throughout if we want since it was defined above
There was a problem hiding this comment.
Alternatively, we should be consistent with all instances spelling out Governance Committee
| considering alternatives, the GC should consider at least the CNCF ecosystem, | ||
| and may also consider other well-known open source projects or alternatives proposed | ||
| by the community. | ||
| 3. If a donation proposal passes the initial GC screening, the Technical Committee (TC) |
There was a problem hiding this comment.
Suggested change
| 3. If a donation proposal passes the initial GC screening, the Technical Committee (TC) | |
| 3. If a donation proposal passes the initial GC screening, the TC |
for consistency we can use TC throughout if we want since it was defined above
|
|
||
| ### Issue lifecycle | ||
|
|
||
| Specification issues are regularly triaged by the GC. The GC may accept, |
There was a problem hiding this comment.
Suggested change
| Specification issues are regularly triaged by the GC. The GC may accept, | |
| Specification issues are regularly triaged by the Governance Committee (GC). The GC may accept, |
|
|
||
| Specification issues are regularly triaged by the GC. The GC may accept, | ||
| decline, or defer the issue until more details are added. Once an issue is | ||
| accepted, it needs a sponsor from the TC who will be responsible for driving the |
There was a problem hiding this comment.
Suggested change
| accepted, it needs a sponsor from the TC who will be responsible for driving the | |
| accepted, it needs a sponsor from the Technical Committee (TC) who will be responsible for driving the |
| Within OpenTelemetry, SIG Maintainers are chosen specifically *because* they | ||
| are domain experts, so we would like to keep as much of the decision-making | ||
| authority with the SIG Maintainers rather than immediately "escalating" to the | ||
| overall OpenTelemetry-wide Technical Committee. As such, this is |
There was a problem hiding this comment.
Suggested change
| overall OpenTelemetry-wide Technical Committee. As such, this is | |
| overall OpenTelemetry-wide Technical Committee (TC). As such, this is |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is some initial work to get a contributor and maintainer's guide added to the community repo. The goal of this work is to collect a lot of the implicit knowledge that exists in the community on how to get started as a contributor or maintainer, and preserve it for new contributors/maintainers, as well as to clarify shared expectations about these roles.
h/t to the Kubernetes project for their work here, as I've borrowed heavily from their community guides to make this PR.
This PR is really intended to get the process started -- I don't want to necessarily block on stuff like 'where do I put ', so let's get a place to put stuff and let people make PRs as need be.