From 6250307cb2cc6c95681728f4923c812ec162aff5 Mon Sep 17 00:00:00 2001 From: Mikel Blanchard Date: Mon, 8 Jan 2024 12:51:27 -0800 Subject: [PATCH] [repo] Update docs with third-party code inclusion guidance (#5195) Co-authored-by: Utkarsh Umesan Pillai <66651184+utpilla@users.noreply.github.com> --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ docs/docfx.json | 4 +++- 3 files changed, 30 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 39203dabfb6..0ff333446eb 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,7 +7,7 @@ Please provide a brief description of the changes here. ## Merge requirement checklist -* [ ] [CONTRIBUTING](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/CONTRIBUTING.md) guidelines followed (nullable enabled, static analysis, etc.) +* [ ] [CONTRIBUTING](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/CONTRIBUTING.md) guidelines followed (license requirements, nullable enabled, static analysis, etc.) * [ ] Unit tests added/updated * [ ] Appropriate `CHANGELOG.md` files updated for non-trivial changes * [ ] Changes in public API reviewed (if applicable) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03e49840017..8106dc2dc43 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -253,3 +253,29 @@ expanding. some housekeeping needs to be done in public API definitions (`.publicApi` folder). This can be done automatically via a code fix offered by the public API analyzer. + +## License requirements + +OpenTelemetry .NET is licensed under the [Apache License, Version +2.0](./LICENSE.TXT). + +### Copying files from other projects + +OpenTelemetry .NET uses some files from other projects, typically where a binary +distribution does not exist or would be inconvenient. + +The following rules must be followed for PRs that include files from another +project: + +* The license of the file is + [permissive](https://en.wikipedia.org/wiki/Permissive_free_software_licence). + +* The license of the file is left intact. + +* The contribution is correctly attributed in the [3rd party + notices](./THIRD-PARTY-NOTICES.TXT) file in the repository, as needed. + +See +[EnvironmentVariablesExtensions.cs](./src/Shared/EnvironmentVariables/EnvironmentVariablesExtensions.cs) +for an example of a file copied from another project and attributed in the [3rd +party notices](./THIRD-PARTY-NOTICES.TXT) file. diff --git a/docs/docfx.json b/docs/docfx.json index 5fc4dfb889f..08ee1d7041b 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -29,7 +29,9 @@ { "files": [ ".editorconfig", - "**.cs" + "**.cs", + "LICENSE.TXT", + "THIRD-PARTY-NOTICES.TXT" ] } ],