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

new LICENSE file incorrect, and would not be detected by github #275

Open
mwichmann opened this issue Oct 8, 2020 · 3 comments · May be fixed by #291
Open

new LICENSE file incorrect, and would not be detected by github #275

mwichmann opened this issue Oct 8, 2020 · 3 comments · May be fixed by #291

Comments

@mwichmann
Copy link

@mwichmann mwichmann commented Oct 8, 2020

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.

@welcome
Copy link

@welcome welcome bot commented Oct 8, 2020

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.

@github-actions github-actions bot added the triage label Oct 8, 2020
@github-actions github-actions bot added this to Triage in Docs team reviews Oct 8, 2020
@zeke
Copy link
Member

@zeke zeke commented Oct 8, 2020

Thanks for the report, @mwichmann 👍🏼

cc @jeffmcaffer who expressed an interest in making sure our licensees correct, discoverable, etc.

@jeffmcaffer
Copy link
Contributor

@jeffmcaffer jeffmcaffer commented Oct 8, 2020

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.

~/git/test$ licensee detect --remote https://github.com/github/docs
License:        NOASSERTION
Matched files:  LICENSE, LICENSE-CODE, README.md, package.json
LICENSE:
  Content hash:  25b636566bb4cee96f8e917e6382b7c4a6858a90
  Confidence:    100.00%
  Matcher:       Licensee::Matchers::Exact
  License:       CC-BY-4.0
LICENSE-CODE:  
  Content hash:  d64f3bb4282a97b37454b5bb96a8a264a3363dc3
  Attribution:   Copyright (c) 2020 GitHub
  Confidence:    100.00%
  Matcher:       Licensee::Matchers::Exact
  License:       MIT
README.md:
  Content hash:  7c25f06c9b30aca9c1da23ad86968bb38db2d53f
  Confidence:    90.00%
  Matcher:       Licensee::Matchers::Reference
  License:       MIT
  Closest non-matching licenses:
    WTFPL similarity:  16.22%
    0BSD similarity:   15.50%
    ISC similarity:    13.89%
package.json:
  Confidence:  90.00%
  Matcher:     Licensee::Matchers::NpmBower
  License:     NOASSERTION
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Linked pull requests

Successfully merging a pull request may close this issue.

4 participants
You can’t perform that action at this time.