Updating documents with changes for REUSE compliance

[gabriel-ku]

Hello!

I work for the Free Software Foundation Europe (FSFE), and we have been working with the NGI0 framework, helping projects with their licensing and copyright management. After a quick check on your repository, I would like to propose some updates regarding copyright and licensing information. REUSE (https://reuse.software) is an FSFE developed initiative intended to make licensing easier by establishing a single way to display all copyright and licensing information through comment headers on source files that can be human- and machine-readable.

The REUSE tool 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.

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 DEP5 file in large directories.

Files Missing Copyright and Licensing Information

To serve as an example, I added the SPDX headers with copyright and license information to the copyrightable files in a few of the directories (namely /includes, /integration, /templates, and /tests). This should give you an idea of how comment headers should look like in a REUSE compliant repository.

Please also double check if the personal information in the headers is correct and consistent. In the event that there are more copyright holders, please include them in these comment headers.

LICENSES Directory in the Root of the Project

I included in this directory the file that contained the MIT license text.

Additionally, I included in this text the CC0 license text. This is because you have files in your project that you do not find 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, which is functionally identical to putting the file in the public domain.

If you find REUSE useful, we offer a wide range of tools to help you continuously check and display compliance with the REUSE guidelines.

Hope that this helps and please feel free to contact me if you have any questions.

Best,
Gabriel
(Free Software Foundation Europe)

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[pfefferle]

Thanks @gabriel-ku but you can't write comments before the opening PHP tag <?php.

Maybe an indirect bug report for the REUSE-CLI ;)

[pfefferle]

It is a known issue: fsfe/reuse-tool#436