Skip to content

Latest commit

 

History

History
152 lines (101 loc) · 8.3 KB

CONTRIBUTING.md

File metadata and controls

152 lines (101 loc) · 8.3 KB
Raw

Contributing to opentelemetry-go-contrib

Welcome to the OpenTelemetry Go contrib repository! Thank you for your interest in contributing to this project. Before you start please be sure to read through these contributing requirements and recommendations.

Become a Contributor

All contributions to this project MUST be licensed under this project's license. You will need to sign the CNCF CLA before your contributions will be accepted.

Code Owners

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. 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 immediate disqualification. You will need to engage with the OpenTelemetry community so you can achieve this membership in the process of becoming a Code Owner.

It is best to have resolved at least an issue related to the module, contributed directly to the module, and/or reviewed module PRs. 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.

Responsibilities

As a Code Owner you will be responsible for the following:

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

Removing Code Ownership

Code Owners are expected to remove their ownership if they cannot fulfill their responsibilities anymore.

It is at the discretion of the repository Maintainers and fellow Code Owners to decide if a Code Owner should be considered for removal. If a Code Owner is determined to be unable to perform their duty, a repository Maintainer will remove their ownership.

Inactivity greater than 5 months, during which time there are active Issues or Pull Requests to address, is deemed an automatic disqualification from being a Code Owner. A repository Maintainer may remove an Code Owner inactive for this length.

Filing Issues

Sensitive security-related issues should be reported to cncf-opentelemetry-tc@lists.cncf.io. See the security policy for details.

When reporting bugs, please be sure to include the following.

  • What version of Go and opentelemetry-go-contrib are you using?
  • What operating system and processor architecture are you using?
  • What did you do?
  • What did you expect to see?
  • What did you see instead?

For instrumentation requests, please see the instrumentation documentation.

Contributing Code

The project welcomes code patches, but to make sure things are well coordinated you should discuss any significant change before starting the work. It's recommended that you signal your intention to contribute in the issue tracker, either by filing a new issue or by claiming an existing one.

Style Guide

  • Code should conform to the opentelemetry-go Style Guide.
  • Make sure to run make precommit - this will find and fix issues with the code formatting.

Pull Requests

All pull requests need to be made from a fork of this repository. Changes should be made using the GitHub flow and submitted as a pull request to this repository.

A pull request is considered ready to merge when the following criteria are meet.

  • It has received two approvals from Approvers/Maintainers (at different companies), unless the change is for an exempt module1.
  • All feedback has been addressed. Be sure to "Resolve" all comments that have been addressed to signal this.
  • Any substantive changes submitted after an Approval removes that Approval. You will need to manually clear these prior Approval reviews to indicate to the reviewer that they need to resubmit their review. This includes changes resulting from other feedback. Unless the approver explicitly stated that their approval will persist across changes it should be assumed that the pull request needs their review again. Other project members (e.g. approvers, maintainers) can help with this if there are any questions or if you forget to clear reviews.
  • If the changes are not trivial, cosmetic, exempt1, or for documentation or dependencies only, the pull request will need to be open for review for at least one working day. This gives people reasonable time to review.
  • CHANGELOG.md has been updated to reflect what has been added, changed, removed, or fixed from the end users perspective. See how to keep a changelog.
  • Urgent fixes can take exception as long as it has been actively communicated.

Any Maintainer can merge the pull request once it is ready to merge.

Draft Pull Requests

It can be helpful at times to publish your incomplete changes. To do this create a draft pull request. Additionally, you can prefix the pull request title with [WIP].

Where to Get Help

You can connect with us in our slack channel.

The Go special interest group (SIG) meets regularly. See the OpenTelemetry community repo for information on this and other language SIGs. See the public meeting notes for a summary description of past meetings.

Approvers and Maintainers

Triagers:

Approvers:

Maintainers:

Emeritus:

Become an Approver or a Maintainer

See the community membership document in OpenTelemetry community repo.

Footnotes

  1. The go.opentelemetry.io/contrib/instrgen module is exempt from the two approvals and one day requirement. Only one approval is needed to merge a Pull Request for that module and there is no minimum amount of time required for the PR to be open before merging. This exemption is to be removed when that package makes its first tagged release. ↩ ↩2