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

add LICENSE file #1343

Closed
wants to merge 1 commit into from
Closed

add LICENSE file #1343

wants to merge 1 commit into from

Conversation

danmaas
Copy link

@danmaas danmaas commented Sep 25, 2018

Hi - I noticed that the GitHub API, and other open-source indexes, are not recognizing the proper license on this repo because there is no LICENSE file. This PR adds the LICENSE.

@styfle
Copy link
Member

styfle commented Sep 25, 2018

There is a license, it's under /docs as you can see here: https://github.com/markedjs/marked/blob/master/docs/LICENSE.md

@danmaas
Copy link
Author

danmaas commented Sep 25, 2018

Ah, sorry about that. GitHub's automated scanner only looks in the root directory of the repo, and I was following that convention, so I missed the one under docs/.

@styfle
Copy link
Member

styfle commented Sep 26, 2018

Where are you seeing this scanner? I would think this is a bug with GitHub since the docs say "most people".

Most people place their license text in a file named LICENSE.txt (or LICENSE.md) in the root of the repository

Maybe marked's license is not detected because of the multiple licenses in one file.

If your repository is using a license that is listed on the Choose a License website and it's not displaying clearly at the top of the repository page, it may contain multiple licenses or other complexity.

https://help.github.com/articles/licensing-a-repository/

@danmaas
Copy link
Author

danmaas commented Sep 26, 2018

Doing a bit more research on this now.

The Github doc linked above implies that they are using this Ruby gem: https://github.com/benbalter/licensee which claims to "score files in the project's root as potential license files" (https://github.com/benbalter/licensee/blob/master/docs/what-we-look-at.md).

But you're probably right about having multiple licenses in one file; GitHub's matcher is pretty crude, and probably wouldn't pick up the licenses automatically even if they were in the root.

Sorry for bothering you about this, I was just trying to follow up on a few discrepancies I've been finding between GitHub projects and package registries, especially pertaining to license and ownership info. Feel free to close the PR.

@styfle
Copy link
Member

styfle commented Sep 26, 2018

I'm closing this ticket since we don't need two licenses so this PR is not necesary.

We'll either leave it as is (in the docs directory) or move it back to root if this ticket doesn't pan out.

Thanks for bringing this up 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants