From a8c453c7bdf5f833c2eba5852181a6c4b9b836bd Mon Sep 17 00:00:00 2001 From: Tyler Benson <734411+tylerbenson@users.noreply.github.com> Date: Wed, 26 Jun 2024 12:01:56 -0400 Subject: [PATCH 1/2] Create CONTRIBUTING.md Fixes #1382 --- CONTRIBUTING.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..3a52e8d91e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,56 @@ +# OpenTelemetry Contributor Guide + +Welcome to OpenTelemetry! This document is the single source of truth for how to +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. +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). + +## 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. From e376c085f774ad138050592bd6cb08742ac2f399 Mon Sep 17 00:00:00 2001 From: Tyler Benson <734411+tylerbenson@users.noreply.github.com> Date: Thu, 27 Jun 2024 12:24:52 -0400 Subject: [PATCH 2/2] Update CONTRIBUTING.md Co-authored-by: Nathan Slaughter <28688390+nslaughter@users.noreply.github.com> --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3a52e8d91e..a62aeff286 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,8 @@ # OpenTelemetry Contributor Guide -Welcome to OpenTelemetry! This document is the single source of truth for how to +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!