Provide licensing information according to REUSE Specification version 3.3 for generated editor SDK files#6637
Draft
kalrish wants to merge 4 commits intoyarnpkg:masterfrom
Draft
Provide licensing information according to REUSE Specification version 3.3 for generated editor SDK files#6637kalrish wants to merge 4 commits intoyarnpkg:masterfrom
kalrish wants to merge 4 commits intoyarnpkg:masterfrom
Conversation
This will let the editor SDK tool create `REUSE.toml` files to comply with the REUSE Specification.
…n 3.3 for generated editor SDK files
arcanis
requested changes
Dec 18, 2024
Member
arcanis
left a comment
There was a problem hiding this comment.
I don't know this REUSE spec, and I'm not very comfortable adding to a core library dependencies to a third-party file parser we don't use elsewhere just for the sake of it.
Author
|
Thank you for reviewing my proposal so quickly :).
I specifically chose Do you want me to:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What's the problem this PR addresses?
The REUSE Specification requires licensing information for each and every file in a repository; as their FAQ states, "you cannot exclude files from REUSE compliance testing". Files generated by the editor SDK tool in the directory
.yarn/sdksare meant to be committed, but they lack the licensing information required by the REUSE Specification. To adhere to the REUSE Specification, repositories that include Yarn editor SDKs must therefore associate licensing information with the editor SDK files with a separately maintainedREUSE.tomlfile, as I've done for my blog.How did you fix it?
I made the editor SDK tool:
REUSE.tomlfile that associates licensing information with the filepackage.jsonthat every editor SDK has.I based the licensing information on the file
LICENSE.md.Checklist