Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upnew LICENSE file incorrect, and would not be detected by github #275
Comments
Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
Thanks for the report, @mwichmann 👍🏼 cc @jeffmcaffer who expressed an interest in making sure our licensees correct, discoverable, etc. |
Thanks @mwichmann. Indeed the LICENSE content is overly complete (love how you put that). Having said that, licensee, the underlying tool that identifies licenses is working as expected and does detect both the CC and MIT licenses. (see output below). The challenge is that the GitHub UI does not deal with multiple licenses and instead opts to say View license and point users at the LICENSE file. So for this issue we should likely invoke the lawyers to ensure we have the right file content and pursue the multi-license handling in the UI separately.
|
What article on docs.github.com is affected?
None
What part(s) of the article would you like to see updated?
None
Additional information
Not a problem of displayed content, but of a file in the repo:
The LICENSE file (recently promoted via #204) is an overly-complete paste from Creative Commons. It includes the preamble (with a bit missing) and afterword, which are intended as instructions to users, and are not part of the license text itself. Lines 1-56 and lines 367-end can (should?) be dropped - search for the ===== delimiters.
In addition, if you select this license, github does not recognize the license when it presents summary information the way it usually does for the project as a whole, and if you click on a LICENSE file (independently tested on a fresh repo since this one is "incorrect" as noded). That's not an error of the docs repo itself, of course, but at least can make the team aware of it.