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

Rename license files to standardised names #89

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

moritztim
Copy link

@moritztim moritztim commented Nov 12, 2024

Summary of all my comments:
Saving the licenses in files named MIT and APACHE2.01 (which is not a valid identifier anyway) prevents tools like VSCode and GitHub (see GitHub docs) as well as users to recognize them as a license file at a glance. The convention is to name them LICENSE, or in the case of multiple files, LICENSE-<name>2. There's also a standardized notation for the case of choice between multiple licenses.3

Footnotes

  1. See https://github.com/rp-rs/rp2040-project-template/pull/89#issuecomment-2471463168

  2. See https://github.com/rp-rs/rp2040-project-template/pull/89/commits/08978253530ed005f7890dc60551f8d5c6e5a712

  3. See https://github.com/rp-rs/rp2040-project-template/pull/89#issuecomment-2471480496

@moritztim
Copy link
Author

I just realised that this is licensed under both the MIT and the Apache 2.0 license... I guess this complicates things a bit. Maybe there should be a third file LICENSE with the license that the actual code here is under, as opposed to the possible licenses that could be chosen for any projects using this template.

@moritztim moritztim marked this pull request as draft November 12, 2024 20:02
The dilemma of two license choices can be solved with the disjunctive "OR" operator defined by SPDX. See https://spdx.github.io/spdx-spec/v3.0.1/annexes/spdx-license-expressions/
@moritztim
Copy link
Author

According to the SPDX specification on composite license expressions you just have to put an "OR" keyword between the license options.

@moritztim moritztim marked this pull request as ready for review November 12, 2024 20:12
@moritztim
Copy link
Author

The "License" tab shows up with this change. Unfortunately, it doesn't show both licenses in full.
The "License" tab on my fork's GitHub page

@moritztim moritztim marked this pull request as draft November 12, 2024 20:14
@moritztim moritztim marked this pull request as ready for review November 12, 2024 20:15
@moritztim moritztim marked this pull request as draft November 12, 2024 20:15
@moritztim
Copy link
Author

This almost works. Unfortunately GitHub doesn't recognize the apache license because it has another dot in its name.
"License" tab
"MIT License" tab

@moritztim
Copy link
Author

moritztim commented Nov 12, 2024

Now it's getting correctly displayed by GitHub.
License tabs on my fork
You might not want to have a third LICENSE file with the standardized expression, since it might be confusing to have three files.
Sidebar
Sorry for the back and forth, it's probably best to squash this.

@moritztim moritztim marked this pull request as ready for review November 12, 2024 20:40
@moritztim moritztim changed the title Rename license file to standardised name Rename license files to standardised names Nov 12, 2024
@jannic
Copy link
Member

jannic commented Nov 12, 2024

The README.md refers to these files as well. ("See MIT or APACHE2.0 for more information on each specific licence.")
That should probably be updated to point to the renamed files.

@moritztim
Copy link
Author

Right, I'll do that

@moritztim moritztim marked this pull request as draft November 12, 2024 21:41
Copy link
Member

@9names 9names left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI our main repo uses the same licences and GitHub detects them correctly.
We should have it done consistently.
https://github.com/rp-rs/rp-hal

@moritztim moritztim marked this pull request as ready for review November 12, 2024 21:47
@moritztim
Copy link
Author

FYI our main repo uses the same licences and GitHub detects them correctly. We should have it done consistently. rp-rs/rp-hal

Yeah, since the readme mentions the dual license with a proper OR clause, I think the LICENSE file might not be needed. I'll remove it and the reference to it if you want.

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.

3 participants