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

Please normalize the license file #40

Closed
wants to merge 1 commit into from
Closed

Please normalize the license file #40

wants to merge 1 commit into from

Conversation

tarsius
Copy link

@tarsius tarsius commented Aug 4, 2017

Rename it from LICENSE.md to LICENSE and remove the markdown.
Also add a License header keyword to nord-emacs.el.

This helps tools that try to automatically detect the license
(such as those used by Github and the Emacsmirror) to do their
job.

Thanks for considering this.

Rename it from LICENSE.md to LICENSE and remove the markdown.
Also add a License header keyword to nord-emacs.el.

This helps tools that try to automatically detect the license
(such as those used by Github and the Emacsmirror) to do their
job.
@tarsius tarsius changed the title Normalize the license file Please normalize the license file Aug 4, 2017
@tarsius
Copy link
Author

tarsius commented Sep 18, 2017

Friendly ping!

@arcticicestudio
Copy link
Contributor

arcticicestudio commented Sep 23, 2017

Sorry for the delay, haven't got much free time to work on my projects.

Is there a specific reason why the Emacsmirror algorithm is not able to detect files with a .md extension?
I've chosen the Markdown format for all of my projects license files due to the better readability, the GitHub documentation recommendations and the fact that it seems like a GitHub standard. GitHub also creates a .md license when using the templates for new repositories and detects the license type.

gh-40-scrot-atom-license

Anyway, the documentation also says the file can be named LICENSE and if it is a kind of standard for Emacs projects there's absolute no problem to adapt to this by merging your changes, just wanted to know the background behind it 😄

@tarsius
Copy link
Author

tarsius commented Sep 24, 2017

Is there a specific reason why the Emacsmirror algorithm is not able to detect files with a .md extension?

Actually that should work too, but something appears to go wrong. I suspect that your copy of the license is too different from the vanilla version in some way for licensee to still recognize it (at least with the default settings).

I extract license information from a package's "main library" using my own (rather crappy) code. But if that fails I also use licensee to get that information from the license file. Github uses that same tool.

The easiest fix as far as my needs are concerned, would be to just add this line to the library header:

;;; License: Apache-2.0

Thanks!

@arcticicestudio
Copy link
Contributor

Thanks for your explanation 👍

I'll go ahead and add the line to the theme if the changes to the LICENSE.md file are not necessarily necessary and are sufficient to properly recognize the license type.

Would be nice if you'd let me know if it works afterwards.

This was referenced Sep 24, 2017
@arcticicestudio
Copy link
Contributor

arcticicestudio commented Sep 24, 2017

I've created #41 and merged #42.

@arcticicestudio
Copy link
Contributor

Superseded by #41

@tarsius
Copy link
Author

tarsius commented Sep 28, 2017

Thanks!
It works.

When will this change be merged into master?

@tarsius
Copy link
Author

tarsius commented Sep 28, 2017

Actually, I think I should just mirror develop instead of master.

@arcticicestudio
Copy link
Contributor

The project uses the gitflow branching model, so the master branch contains the annotated version tags while develop contains the latest commits.

I've got a free day today, actually working on some port projects and hope to implement a feature (theme config) today, so maybe there will be a new release today in master.

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

Successfully merging this pull request may close these issues.

2 participants