Skip to content
This repository has been archived by the owner on Jul 31, 2024. It is now read-only.

NGI - Updating licensing aspects according to REUSE #16

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

Conversation

lnceballosz
Copy link

Hello,

I work for the Free Software Foundation Europe (FSFE), and we have been working with the NGI 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 throughout this pull request to serve as a guideline for how you can further make more clear your legal information display.

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

REUSE Features:

Copyright and Licensing Information in each file

One of the main features of REUSE is that each file in the repository contains copyright and license information with the help of a comment header that is human- and machine-readable. I noticed that this has already been done in some of the files in your repo, for example, the files in dist/ scr/xfragment folders. What I did was include the machine-readable headers with the help of the reuse tool for some others that missed this info. I also decided to use the argument --no-replace to preserve existing headers .

As stated, I was able to add headers to some files of certain directories. However, as this serves as a guideline, I did not do so for all of them. I didn't touch directories such as src/3rd/js/plugin/ or doc/ since it has quite some documentation files for which the license and copyright information is not clear.

Please note that REUSE has also an option to add this information for binary and uncommentable files, as well as for insignificant files - no copyrightable files such as .gitignore. As you can see, I've added the .license file to some of the json files on src/spec please check that the license and copyright information of such files is correct.

LICENSES directory in the root of the project with the licenses used on the repository:

I included in this directory the files with the text of the MPL-2.0 License - which from my understanding is the main license of the repository. Please feel free to correct this information and adapt the rest of the files according to the correct license and copyright information. In the case of other existing licenses, please do not forget to include the text of such in the LICENSES/ folder.

I did not do anything with the existing file LICENSE in the root of the directory. It is up to you if you want to keep it or delete it, however, this won't affect the REUSE specification.

Files missing copyright and licensing information:

Please feel free to check the REUSE documentation and the helper tool , and if you are interested in making your project REUSE compliant, please add the legal information to the missing files. I am also available if you want support with the process.

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. In case you want to license certain files under a different license, special attention should also be paid to that aspect and such files should contain the appropriate SPDX tag.

Wide range of tools

In case you find REUSE useful, we offer other tools to help you continuously check and display compliance with the REUSE guidelines. For instance, you can automatically run reuse lint on every commit as a pre-commit hook for Git. And, it can be easily integrated into your existing CI/CD processes to continuously test your repository and its changes for REUSE compliance.

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

@coderofsalvation
Copy link
Owner

coderofsalvation commented Jul 12, 2024

good stuff, thanks!
I will incorporate the changes (branch is now out of sync)

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

Successfully merging this pull request may close these issues.

2 participants