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

Create CONTRIBUTING.md #1407

Merged
merged 2 commits into from
Jul 16, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# OpenTelemetry Contributor Guide

Welcome to OpenTelemetry! This document provides general guidance for contributing to
this codebase. This is a multi-lingual codebase, so sub-directories like `collector` may
provide additional guidance in a CONTRIBUTING.md.
contribute to the code base. Feel free to browse the [open
issues](https://github.com/open-telemetry/opentelemetry-lambda/issues?q=is%3Aissue+is%3Aopen)
and file new ones, all feedback welcome!

## Before you get started

### Code of Conduct

Please make sure to read and observe our [Code of
Conduct](https://github.com/open-telemetry/community/blob/master/code-of-conduct.md).

### Sign the CLA

Before you can contribute, you will need to sign the [Contributor License
Agreement](https://docs.linuxfoundation.org/lfx/easycla/contributors).

### Code attribution

[License information](README.md#License) should be included in all source files where applicable.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a workflow in the Makefile for this.

Either full or short version of the header should be used as described at [apache.org](http://www.apache.org/foundation/license-faq.html#Apply-My-Software).
It is OK to exclude the year from the copyright notice. For the details on how to apply the copyright,
see the next section.

### Copyright Notices

OpenTelemetry follows [CNCF recommendations](https://github.com/cncf/foundation/blob/master/copyright-notices.md)
for copyright notices. We use "Copyright The OpenTelemetry Authors" notice form.

According to CNCF recommendations if you are contributing third-party code
you will need to [retain the original copyright notice](https://github.com/cncf/foundation/blob/master/copyright-notices.md#dont-change-someone-elses-notice-without-their-permission).

Any contributed third-party code must originally be Apache 2.0-Licensed or must
carry a permisive software license that is compatible when combining with
Apache 2.0 License. At this moment, BSD and MIT are the only
[OSI-approved licenses](https://opensource.org/licenses/alphabetical) known to be compatible.

If you make substantial changes to the third-party code, _prepend_ the contributed
third party file with OpenTelemetry's copyright notice.

If the contributed code is not third-party code and you are the author we
strongly encourage to avoid including your name in the notice and use the
generic "Copyright The OpenTelemetry Authors" notice. See rationale for this
recommendation [here](https://github.com/cncf/foundation/blob/master/copyright-notices.md#why-not-list-every-copyright-holder).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some much needed clarity for just about everybody. Glad we're including this in guidance.

## Community Expectations and Roles

OpenTelemetry is a community project. Consequently, it is wholly dependent on
its community to provide a productive, friendly, and collaborative environment.

- See [Community
Membership](https://github.com/open-telemetry/community/blob/master/community-membership.md)
for a list the various responsibilities of contributor roles. You are
encouraged to move up this contributor ladder as you gain experience.
Loading