Skip to content

Commit

Permalink
[repo] Update docs with third-party code inclusion guidance (#5195)
Browse files Browse the repository at this point in the history
Co-authored-by: Utkarsh Umesan Pillai <[email protected]>
  • Loading branch information
CodeBlanch and utpilla authored Jan 8, 2024
1 parent d73ed67 commit 6250307
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 3 additions & 1 deletion docs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@
{
"files": [
".editorconfig",
"**.cs"
"**.cs",
"LICENSE.TXT",
"THIRD-PARTY-NOTICES.TXT"
]
}
],
Expand Down

0 comments on commit 6250307

Please sign in to comment.