-
Notifications
You must be signed in to change notification settings - Fork 682
Add code owner policy #5555
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
Merged
Merged
Add code owner policy #5555
Changes from 5 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
bd77b68
Add Code Owners policy
MrAlias 3a13877
Add Code Owner Request Issue template
MrAlias 1d11522
Add changelog entry
MrAlias 30b7a2c
Merge branch 'main' into doc-code-owner
MrAlias 10e1012
Fix lint
MrAlias 1e06f18
Merge branch 'main' into doc-code-owner
MrAlias e381cd1
Apply suggestions from code review
MrAlias 459445d
Merge branch 'main' into doc-code-owner
MrAlias 42b5bb7
Add Removing Code Ownership section
MrAlias eac8ed0
Merge branch 'main' into doc-code-owner
MrAlias 75936a9
Apply suggestions from code review
MrAlias File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
name: 'Code Owner Request' | ||
about: Request to become a Code Owner for a module | ||
title: 'Request to become a Code Owner' | ||
|
||
--- | ||
|
||
Module: [e.g. go.opentelemetry.io/contrib/zpages] | ||
|
||
### Requirements | ||
|
||
- [ ] I am a [member of the OpenTelemetry organization] | ||
- [ ] I will maintain my OpenTelemetry organization membership as a Code Owner | ||
- [ ] I have good working knowledge of the code in the module | ||
- [ ] I have good working knowledge of the technology the module supports | ||
- [ ] I understand I will be responsible for keeping up with the changes to technology the module supports | ||
- [ ] I understand I will be expected to review any Pull Requests or Issues created that relate to this module | ||
- [ ] I understand I will be responsible for the stability and versioning compliance of the module | ||
- [ ] I understand I will be responsible for deciding any additional Code Owners of the module | ||
|
||
[member of the OpenTelemetry organization]: https://github.com/open-telemetry/community/blob/main/community-membership.md#member | ||
|
||
### Relvant experience | ||
|
||
List any PRs/Issues you have interacted with in this repository for this module. | ||
|
||
Additionally, provide any experience you have related to the underlying technology the module supports. |
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,6 +9,44 @@ Before you start please be sure to read through these contributing requirements | |
All contributions to this project MUST be licensed under this project's [license](LICENSE). | ||
You will need to sign the [CNCF CLA](https://identity.linuxfoundation.org/projects/cncf) before your contributions will be accepted. | ||
|
||
## Becoming a Code Owner | ||
|
||
To ensure code that lives in this repository is not abandoned, all modules added are required to have a Code Owner. | ||
A Code Owner is responsible for a module within this repository. | ||
This status is identified in the [CODEOWNERS file](./CODEOWNERS). | ||
That responsibility includes maintaining the component, triaging and responding to issues, and reviewing pull requests. | ||
|
||
### Requirements | ||
|
||
To become a Code Owner, you will need to meet the following requirements. | ||
|
||
1. You will need to be a [member of the OpenTelemetry organization] and maintain that membership. | ||
2. You need to have good working knowledge of the code you are sponsoring and any project that that code instruments or is based on. | ||
|
||
If you are not an existing member, this is not an imediate disqualification. | ||
You will need to engate with the OpenTelemetry community so you can achieve this membership in the process of becoming a Code Owner. | ||
MrAlias marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
It is best to have resolved an issue related to the module, contributed directly to the module, and/or review module PRs. | ||
MrAlias marked this conversation as resolved.
Show resolved
Hide resolved
|
||
How much interaction with the module is required before becoming a Code Owner is up to the existing Code Owners. | ||
|
||
Code Ownership is ultimately up to the judgement of the existing Code Owners and Maintainers of this repository. | ||
Meeting the above requirements is not a guarantee to be granted Code Ownership. | ||
|
||
[member of the OpenTelemetry organization]: https://github.com/open-telemetry/community/blob/main/community-membership.md#member | ||
|
||
### Responsibilities | ||
|
||
As a Code Owner you will be responsible for the following. | ||
MrAlias marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- You will be responsible for keeping up with the instrumented library. Any "upstream" changes that impact this module need to be proactively handle by you. | ||
- You will be expected to review any Pull Requests or Issues created that relate to this module. | ||
- You will be responsible for the stability and versioning compliance of the module. | ||
- You will be responsible for deciding any additional Code Owners of the module. | ||
|
||
### How to become a Code Owner | ||
|
||
To become a Code Owner, open [an Issue](https://github.com/open-telemetry/opentelemetry-go-contrib/issues/new?assignees=&labels=&projects=&template=owner.md&title=). | ||
|
||
## Filing Issues | ||
|
||
Sensitive security-related issues should be reported to <[email protected]>. See the [security policy](https://github.com/open-telemetry/opentelemetry-go-contrib/security/policy) for details. | ||
|
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.
Uh oh!
There was an error while loading. Please reload this page.