Updating for compliance with REUSE Specification

[gabriel-ku]

By way of introduction, my name is Gabriel and I work for the Free Software Foundation Europe, a consortium member of the NGI0 initiative. Part of what is offered with your involvement with NGI0 is help from us with your project on your copyright and license management in your project repo(s).

After a quick check on your repository, I would like to propose some updates regarding copyright and licensing information in your files. Our REUSE specification (https://reuse.software) intends to make licensing easier with best practices to display legal information through comment headers on source files that can be easily human and machine readable. The REUSE tool we have developed to support this specification also makes the process of applying licenses to files and compliance checking much easier.

Instructions on how to install the REUSE tool can be found here: https://reuse.readthedocs.io/en/stable/readme.html#install

You can also check out this screencast for more instructions on how to use the REUSE tool: https://download.fsfe.org/videos/reuse/screencasts/reuse-tool.gif

The changes in this pull request have also been made for you to understand the basic ideas behind REUSE, and how adopting the REUSE practices would look like within your repository.

REUSE Features:

• SPDX copyright and license comment headers for relevant files. 
• LICENSES directory with licenses used in the repository 
• Associating copyright/licensing information through a REUSE.toml file in large directories. 

Files Missing Copyright and Licensing Information

The main idea behind REUSE is that every single file in your repository should have a header that includes information about your copyright and licensing, in a machine-readable format.

To serve as an example, I added the SPDX headers with copyright and license information to the copyrightable files in the a number of your folders. This should give you an idea of how comment headers should look like in a REUSE compliant repository, and how they should be added to the other source code files in your repository.

Please also check if the personal information in these headers are correct and consistent to your knowledge (I have merely used Roman's name there as a placeholder, as I am not in a position to know the copyright applicable to each file in the repo). You may also add an email address or the project weblink if you so choose (I refrained from doing so here in case you did not wish for this information to be publicly viewed). In the event that there are more copyright holders, please include them in these comment headers.

Additionally, I have used the GPL3 as the default license of choice, pursuant to our email conversation. Please feel free to amend this according to your needs.

LICENSES Directory in the Root of the Project Repository

The LICENSES Folder should contain the license text of every license applicable in your repository.

I included in this folder the text for the CC0 license. This is because you have files in your project that are not copyrightable, for example configuration files such as .gitignore. As the fundamental idea of REUSE is that all of your files will clearly have their copyright and licensing marked, I have applied the CC0 license to .gitignore as an example, which is functionally identical to putting the file into the public domain.

Licensing of Image Files (or Non-Editable Files)

The licensing and copyright information of image files or other similarly non-editable files can be done by creating a separate text file for the comment header, titled "Original-File-Name.license". So for example, the comment header for an image file titled "Dog.jpg" would be contained in a separate file titled "Dog.jpg.license". I have done this for the .json files in the .vscode folder, as an example.

Alternatively, if you have a large folder with many non-editable files where it would be impractical to create separate .license files for each file, you can bulk license folders with the same copyright and license information using a REUSE.toml file.

I hope that you find this useful and please feel free to contact me directly at [email protected] if you have any questions.

Best,
Gabriel
(Free Software Foundation Europe)

[brainstorm]

Thanks heaps for your PR and guidance with this, @gabriel-ku !