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 SPDX-compatible licence info to each file #449

Open
robinpaulson opened this issue Mar 28, 2020 · 10 comments
Open

Add SPDX-compatible licence info to each file #449

robinpaulson opened this issue Mar 28, 2020 · 10 comments

Comments

@robinpaulson
Copy link
Contributor

Following on from the discussion here , in which we brought up the idea of adding licence info to each (text) file in the Forecastie repo.

More info on SPDX here

@robinpaulson
Copy link
Contributor Author

I think this can be done in one shot with a shell script and a simple sed line.

Is it also worthwhile adding the info to binary images, e.g. in the comments field (I think some image specs have this concept).

@robinpaulson
Copy link
Contributor Author

robinpaulson commented Mar 28, 2020

I think this is the text we will use:
Java files:
// SPDX-License-Identifier: GPL-3.0-or-later
XML/HTML files:
<!-- SPDX-License-Identifier: GPL-3.0-or-later -->

I'm going to ignore gradle, proguard and readme/contributing/CoC files

@sotpapathe has already added SPDX text, I'm pleased to see

Any comments?

@robinpaulson
Copy link
Contributor Author

robinpaulson commented Mar 28, 2020

sed -i '3i3 // SPDX-License-Identifier: GPL-3.0-or-later' <filename>

sed -i '3i3 <!-- SPDX-License-Identifier: GPL-3.0-or-later -->' <filename>

@robinpaulson
Copy link
Contributor Author

sed -i '3i3 // SPDX-FileCopyrightText: 2015-2020 Tomáš Martykán and others' <filename>

@robinpaulson
Copy link
Contributor Author

robinpaulson commented Mar 28, 2020

We can add info to png files like so:

mogrify -comment "SPDX-FileCopyrightText: 2015-2020 Tomáš Martykán and others\nSPDX-License-Identifier: GPL-3.0-or-later" <filename.png>

@robinpaulson
Copy link
Contributor Author

I think we should put the artwork under a different licence. I've opened a separate issue: #450.

@robinpaulson
Copy link
Contributor Author

Question: are xml image files, which are similar to SVG, best thought of as code, thus GPL3+, or images, thus the answer to #450?

@sotpapathe
Copy link
Contributor

There is also the FSFE REUSE initiative which has a few more (fairly easy to follow) guidelines and a tool that checks compliance. Even if the spec is not followed to the letter, the tool might be useful to find any files that might have been missed.

@robinpaulson
Copy link
Contributor Author

@sotpapathe Great, cheers

@robinpaulson
Copy link
Contributor Author

REUSE is very interesting, I ran it on the repo .... lots of files with missing licence info of course. I'll put a note in the CONTRIBUTING.md file, along with the script you wrote.

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

No branches or pull requests

2 participants