Skip to content

Updating licensing aspects according to REUSE

Lina Ceballos requested to merge lnceballos/ponci:reuse into main

Hello,

By means of introduction, I am Lina Ceballos part of the Free Software Foundation Europe (FSFE); a charity that empowers users to control technology. We learned about your project some weeks ago, and we find it very interesting. So we decided to contribute with some legal features. One of our main legal activities is REUSE. The REUSE specifications intend to make licensing easier by setting one way to display all this legal information through comment headers on source files that can be human - and machine – readable. We have been helping projects with their licensing and copyright management by implementing REUSE features in their projects. After a check on your repository, I would like to propose some updates regarding copyright and licensing information according to the these specifications.

The REUSE tool makes the process of applying licenses to files and compliance checking much easier. Check this screencast:

https://download.fsfe.org/NGI0/reuse.webm

Feel completely free to adopt these specifications by merging this pull request and to follow up on that!

REUSE Features:

  • SPDX copyright and license comment headers for all relevant files
  • LICENSES directory with the licenses used on the repository
  • Associating Copyright/ Licensing information through a DEP5 file in large directories.
  • Licensing and copyright display of binary and non-editable files. Please be aware that I licensed one image file docs/diagrams/images/app_verification_flow as an example of how to create a license file for an image file, but since the image files in your repository make part of the large directory that I have included in the dep5 file, all the image files by default have already copyright and license information. I also created the .license file for the file go.sum
  • Licensing insignificant files (e.g .gitignore) under CC0-1.0 (public domain)

Files missing copyright and licensing information:

I noticed that most of your source code files had already some headers, so I just modified them by adding the SPDX headers that will make your project REUSE compliant. I left the existing headers there as well, to be less intrusive.

As good practice; I added license information in the README file.

Please also double check if the personal information in the headers is correct and consistent, in the case of several copyright holders please update that information in the headers.

So if you run now the reuse tool you will see that your project is REUSE compliant :)

Further REUSE compliance

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

Hope that helps and thank you very much for the amazing job!

Merge request reports