Add "license" field to Community Module JSON schema. #25085
Merged
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.
This PR adds an optional "
license
" field to indicate a license in theqmk_module.json
file of a community module.Description
It is desirable that module authors indicate a license to clarify how the module may be used and shared, to foster collaboration and wider adoption.
A simple string "
license
" field is added to the schema forqmk_module.json
.In the documentation, I recommend that this field is a SPDX license identifier like "
Apache-2.0
" or "GPL-2.0-or-later
" if possible. Even so, the field allows an open-ended text description in case of more complex licensing situations.I updated the
qmk/hello_world
andqmk/super_alt_tab
modules with"license": "GPL-2.0-or-later"
, matching the license on their source files.While I was at it, I updated the docs to mention the (currently undocumented) "
url
" field, which is something else I have been wanting.Types of Changes
Checklist