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

[repo] Update docs with third-party code inclusion guidance #5195

Merged

Conversation

CodeBlanch
Copy link
Member

Relates to #5187

Changes

  • Update CONTRIBUTING.md to have guidance for third-party code inclusion. Inspired by dotnet/runtime CONTRIBUTING.md.
  • Add a note on PR template about license requirements.

Merge requirement checklist

  • CONTRIBUTING guidelines followed (nullable enabled, static analysis, etc.)

@CodeBlanch CodeBlanch requested a review from a team December 20, 2023 21:56
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated
- The license of the file is
[permissive](https://en.wikipedia.org/wiki/Permissive_free_software_licence).
- The license of the file is left in-tact.
- The contribution is correctly attributed in the [3rd party
Copy link
Contributor

Choose a reason for hiding this comment

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

Would you be attributing the existing third-party code in the THIRD-PARTY-NOTICES.TXT in some follow-up PR?

Copy link
Member Author

Choose a reason for hiding this comment

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

That's what #5190 was all about. You think any more is needed?

Copy link
Contributor

Choose a reason for hiding this comment

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

I was checking the dotnet runtime repo's THIRD-PARTY-NOTICES.TXT and their attributions are more specific where they list out the individual components/file copied along with the project URL that it's copied from.

I was wondering if we want to do that as well instead of having a blanket attribution to "Copyright (c) .NET Foundation and Contributors".

Just a thought. Not a blocker by any means.

Copy link
Contributor

This PR was marked stale due to lack of activity and will be closed in 7 days. Commenting or Pushing will instruct the bot to automatically remove the label. This bot runs once per day.

@github-actions github-actions bot added the Stale Issues and pull requests which have been flagged for closing due to inactivity label Dec 30, 2023
@github-actions github-actions bot removed the Stale Issues and pull requests which have been flagged for closing due to inactivity label Jan 3, 2024
@alanwest
Copy link
Member

alanwest commented Jan 4, 2024

@CodeBlanch just a few links that need fixing

https://github.com/open-telemetry/opentelemetry-dotnet/actions/runs/7305743476/job/19909675451?pr=5195#step:4:834

[23-12-23 02:48:31.473]Warning:[BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](CONTRIBUTING.md#L275)Invalid file link:(~/THIRD-PARTY-NOTICES.TXT).
[23-12-23 02:48:31.473]Warning:[BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](CONTRIBUTING.md#L280)Invalid file link:(~/THIRD-PARTY-NOTICES.TXT).
[23-12-23 02:48:31.473]Warning:[BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](CONTRIBUTING.md#L259)Invalid file link:(~/LICENSE.TXT).

@reyang
Copy link
Member

reyang commented Jan 8, 2024

@CodeBlanch FYI - adding *.TXT files to

"resource": [
{
"files": [
".editorconfig",
"**.cs"
]
should fix the docfx build failure.

Copy link

codecov bot commented Jan 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (0889e8d) 83.44% compared to head (0c5d3ff) 83.40%.
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #5195      +/-   ##
==========================================
- Coverage   83.44%   83.40%   -0.04%     
==========================================
  Files         297      297              
  Lines       12531    12531              
==========================================
- Hits        10456    10451       -5     
- Misses       2075     2080       +5     
Flag Coverage Δ
unittests 83.40% <ø> (-0.04%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 7 files with indirect coverage changes

@CodeBlanch CodeBlanch merged commit 6250307 into open-telemetry:main Jan 8, 2024
76 checks passed
@CodeBlanch CodeBlanch deleted the third-party-license-guide branch January 8, 2024 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants