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

[5.9] Revert "[5.9] Removed the md extension from LICENSE" #29069

Merged
merged 1 commit into from
Jul 5, 2019

Conversation

driesvints
Copy link
Member

@driesvints driesvints commented Jul 4, 2019

Reverts #29041

It doesn't matter if it's Markdown. Markdown is a plain-text format. This is the same across all the other repos. Markdown will also neatly render in Github. This is also pretty much the standard across other popular open source libraries (Spatie, Zend, Beyond Code, ...)

@driesvints driesvints changed the title Revert "[5.9] Removed the md extension from LICENSE" [5.9] Revert "[5.9] Removed the md extension from LICENSE" Jul 4, 2019
@GrahamCampbell
Copy link
Member

👎 The convention is, however, not use use the md extension. In particular, software that automatically checks licenses may only look for LICENSE.

@antonkomarev
Copy link
Contributor

antonkomarev commented Jul 4, 2019

I suppose Spatie & Beyond Code are using .md extension because Laravel used it when they were deciding how to name a file. Symfony using LICENSE name without extension.

@driesvints
Copy link
Member Author

We're already using a Markdown extension across all other Laravel libraries. It's a plain-text file. I really don't see the need to change this.

@BrandonSurowiec
Copy link
Contributor

For what it is worth, the 5.8 branch (with .md) shows a nice license summary at the top of the page on Github, but the extension-less one does not. I vote to revert.

@antonkomarev
Copy link
Contributor

That's strange because in all my packages license summary displays for files without extension without any issues: https://github.com/cybercog/laravel-love/blob/master/LICENSE

@BrandonSurowiec
Copy link
Contributor

@antonkomarev Guess I'm wrong then :)

@antonkomarev
Copy link
Contributor

Maybe github will switch license parser to new naming only after next release... who knows...

@GrahamCampbell
Copy link
Member

GitHub only renders licenses determined by the default branch of a repo, which is 5.8 for us.

@staudenmeir
Copy link
Contributor

An argument against the md extension: GitHub adds a LICENSE file when you create a new repository and select a license.

@taylorotwell taylorotwell merged commit f9ce03f into master Jul 5, 2019
@taylorotwell
Copy link
Member

I'm fine with reverting it until we can get all of the repositories done across the ecosystem. I don't have a strong preference either way.

@driesvints driesvints deleted the revert-29041-license branch July 5, 2019 11:05
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.

7 participants