🐛 Clarify licensing checks documentation #3967
Closed
Conversation
This file contains 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
Signed-off-by: Max Mehl <6170081+mxmehl@users.noreply.github.com>
mxmehl
changed the title
Signed-off-by: Max Mehl <6170081+mxmehl@users.noreply.github.com>
There was a problem hiding this comment.
Please see our CONTRIBUTING.md.
Both PR titles and Updating docs
You can't edit docs/checks.md directly.
Comment on lines
383
to
+384
| [SPDX](https://spdx.org/licenses/) license identifier followed by an | ||
| appropriate file extension, as described in the [REUSE](https://reuse.software/spec/) Specification.) | ||
| appropriate file extension, as described in the [REUSE](https://reuse.software/spec/ Specification).) |
There was a problem hiding this comment.
this breaks the link
|
This pull request has been marked stale because it has been open for 10 days with no activity |
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 kind of change does this PR introduce?
This PR fixes a typo for the
LICENSESdirectory, which was in one place calledLICENSEdirectory.Furthermore, it makes a proposal for a better wording of where licenses are searched for. As I am not aware how the tool works internally, this should be reviewed.
What is the current behavior?
The check documentation and the recommendations are unclear and partly misleading.
Does this PR introduce a user-facing change?