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, fix and improve licenses #28

Merged
merged 11 commits into from
Feb 2, 2021
Merged

Conversation

HipyCas
Copy link
Contributor

@HipyCas HipyCas commented Feb 2, 2021

What was done?

This PR is the first of many PRs about licenses. This first one adds many licenses, reorders them, makes the switch to SPDX identifiers and fixes some other issues.

Other than licenses, a small typo was fixed in the colors of file extensions, specifically in the Swift language.

New license naming standard

The way licenses are registered is now as discussed in issue #27. They are now identified by their corresponding SPDX identifier, that is the first string in a license item in the list. They have also been reordered, following an alphabetical order based on the SPDX identifier.

Licenses added

Below are listed the licenses added in this PR, more are to be added in other PRs.

  • APSL-2.0:
  • MIT-0:
  • LGPL-2.1:
  • AFL-3.0:
  • APL-1.0:
  • AFL-3.0:

By any means this list is complete, and more work will be put into license registration in the future.

Issues related

Resolves #27 and contributes to #7.

Documentation on licenses

The sources used for the expansion of the list are cited as comments below the choosealicense.com one. These sources are the Open Source Initiative (for licenses and their SPDX identifiers) and the official SPDX webpage (for the full license text).

In addition to the sources, two lien comments have been added. These comments simply add a little bit of documentation about how the LICENSE list is structured, stating how it is ordered and what each string means. These comments were put in place to help future contributors better understand how to contribute to this license.

Change the short indentifier for the Boost Software Licens - Version 1.0.
The new identifier correponds to the SPDX short identifier.
The source of this identifier is the [Open Source Initiative](https://opensource.org/licenses/BSL-1.0).
Three new licenses are added in this commit: MIT-0, LGPLv2.1, APSL-2.0.
The short name for these licenses corresponds to their SPDX identifier, except for LGPLV2.1.
The logn name is similar to the closest license, for example LGPLv3 for LGPLv2.1.

The source of these lincenses is [Open Source Initiative](https://opensource.org/licenses/alphabetical).
Added the link to the [Open Source Initiative](https://opensource.org/licenses/) license list next to choosealicense.com.
Like choosealicense.com, it is added as comment on top of LICENSES declaration.

The information of the licenses was extracted from the alphabetical ordered list, although a more generic link is provided here.
Two new licenses are added in this commit: AFL-3.0, APL-1.0.
The short name for these licenses corresponds to their SPDX identifier.
The long name is similar to the closest licenses.

The source of these lincenses is [Open Source Initiative](https://opensource.org/licenses/alphabetical).
All licenses identifier is now set to their SPDX identifier.
These identifiers have been collected from the [Open Source
Initiative](https://opensource.org/licenses/alphabetical).
Fixed a small error in the Swift comment in the file extension colors.
This commit fixes an error caused by a missing comma in the licenses list.
The error was caused in line 37 after the LGPL-2.1 license.
Updated all added licenses starting text to the actual first part of the license text.
See issue The-Noah#27 for background on this commit.
After using the SPDX website as source of licenses texts, it is now added to licenses sources.
The website offers a long list of licenses, with their SPDX identifier and full text.
Licenses are ordered by alphabet order in this commit, following their SPDX identifier.
A small error in APSL-2.0 was fixed, as the S was missing.
Simply adds two lines of comments indicating how the LICENSES list works.
It indicates what are the strings in each license and how they are ordered.
@HipyCas HipyCas requested a review from The-Noah as a code owner February 2, 2021 18:43
@The-Noah The-Noah merged commit 034d8df into The-Noah:master Feb 2, 2021
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.

Consistent License naming
2 participants